The allocation strategy to use for the compute resource if not enough instances of the best\n fitting instance type can be allocated. This might be because of availability of the instance\n type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch selects an instance type that best fits the needs of the jobs with a preference\n for the lowest-cost instance type. If additional instances of the selected instance type\n aren't available, Batch waits for the additional instances to be available. If there aren't\n enough instances available or the user is reaching Amazon EC2 service limits,\n additional jobs aren't run until the currently running jobs are completed. This allocation\n strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with\n BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use\n a BEST_FIT allocation strategy don't support infrastructure updates and can't\n update some parameters. For more information, see Updating compute environments in\n the Batch User Guide.
Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.
\nBatch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.
The allocation strategy to use for the compute resource if not enough instances of the best\n fitting instance type can be allocated. This might be because of availability of the instance\n type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch selects an instance type that best fits the needs of the jobs with a preference\n for the lowest-cost instance type. If additional instances of the selected instance type\n aren't available, Batch waits for the additional instances to be available. If there aren't\n enough instances available or the user is reaching Amazon EC2 service limits,\n additional jobs aren't run until the currently running jobs are completed. This allocation\n strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with\n BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use\n a BEST_FIT allocation strategy don't support infrastructure updates and can't\n update some parameters. For more information, see Updating compute environments in\n the Batch User Guide.
Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.
\nBatch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.
\nThe price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.
The maximum number of\n vCPUs that a\n compute environment can\n support.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. For example, no more than a single instance from among those specified in your compute\n environment is allocated.
The maximum number of\n vCPUs that a\n compute environment can\n support.
\nWith BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. For example, no more than a single instance from among those specified in your compute\n environment is allocated.
The maximum number of Amazon EC2 vCPUs that an environment can reach.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. That is, no more than a single instance from among those specified in your compute\n environment.
The maximum number of Amazon EC2 vCPUs that an environment can reach.
\nWith BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, and SPOT_PRICE_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. That is, no more than a single instance from among those specified in your compute\n environment.
The allocation strategy to use for the compute resource if there's not enough instances of\n the best fitting instance type that can be allocated. This might be because of availability of\n the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.
\nWhen updating a compute environment, changing the allocation strategy requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide. BEST_FIT isn't\n supported when updating a compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.
\nBatch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.
The allocation strategy to use for the compute resource if there's not enough instances of\n the best fitting instance type that can be allocated. This might be because of availability of\n the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.
\nWhen updating a compute environment, changing the allocation strategy requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide. BEST_FIT isn't\n supported when updating a compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.
\nBatch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.
\nThe price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith both BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, and SPOT_PRICE_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.
Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a\n specified percentage of the On-Demand price.
\nMulti-node parallel jobs aren't supported on Spot Instances.
\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how\n you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of\n your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.
\nTo create a compute environment that uses EKS resources, the caller must have permissions to call\n eks:DescribeCluster.
Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it\n also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is\n available. You're responsible for the management of the guest operating system. This includes any updates and\n security patches. You're also responsible for any additional application software or utilities that you install on\n the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete\n these steps:
\nCreate a new compute environment with the new AMI.
\nAdd the compute environment to an existing job queue.
\nRemove the earlier compute environment from your job queue.
\nDelete the earlier compute environment.
\nIn April 2022, Batch added enhanced support for updating compute environments. For more information, see\n Updating compute\n environments. To use the enhanced updating of compute environments to update AMIs, follow these\n rules:
\nEither don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.
Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE\n or SPOT_CAPACITY_OPTIMIZED.
Set the update to latest image version (updateToLatestImageVersion)\n parameter to\n true.\n The updateToLatestImageVersion parameter is used when you update a compute\n environment. This parameter is ignored when you create a compute\n environment.
Don't specify an AMI ID in imageId, imageIdOverride (in \n ec2Configuration\n ), or in the launch\n template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's\n supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID\n in the imageId or imageIdOverride parameters, or the launch template identified by the\n LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the\n AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the\n imageId or imageIdOverride parameters. It can only be replaced by specifying a different\n launch template, or if the launch template version is set to $Default or $Latest, by\n setting either a new default version for the launch template (if $Default) or by adding a new version\n to the launch template (if $Latest).
If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be\n re-selected. If the version setting in the launch template (launchTemplate) is set to\n $Latest or $Default, the latest or default version of the launch template is evaluated up\n at the time of the infrastructure update, even if the launchTemplate wasn't updated.
Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a\n specified percentage of the On-Demand price.
\nMulti-node parallel jobs aren't supported on Spot Instances.
\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how\n you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of\n your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.
\nTo create a compute environment that uses EKS resources, the caller must have permissions to call\n eks:DescribeCluster.
Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it\n also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is\n available. You're responsible for the management of the guest operating system. This includes any updates and\n security patches. You're also responsible for any additional application software or utilities that you install on\n the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete\n these steps:
\nCreate a new compute environment with the new AMI.
\nAdd the compute environment to an existing job queue.
\nRemove the earlier compute environment from your job queue.
\nDelete the earlier compute environment.
\nIn April 2022, Batch added enhanced support for updating compute environments. For more information, see\n Updating compute\n environments. To use the enhanced updating of compute environments to update AMIs, follow these\n rules:
\nEither don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.
Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE, \n SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.
Set the update to latest image version (updateToLatestImageVersion)\n parameter to\n true.\n The updateToLatestImageVersion parameter is used when you update a compute\n environment. This parameter is ignored when you create a compute\n environment.
Don't specify an AMI ID in imageId, imageIdOverride (in \n ec2Configuration\n ), or in the launch\n template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's\n supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID\n in the imageId or imageIdOverride parameters, or the launch template identified by the\n LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the\n AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the\n imageId or imageIdOverride parameters. It can only be replaced by specifying a different\n launch template, or if the launch template version is set to $Default or $Latest, by\n setting either a new default version for the launch template (if $Default) or by adding a new version\n to the launch template (if $Latest).
If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be\n re-selected. If the version setting in the launch template (launchTemplate) is set to\n $Latest or $Default, the latest or default version of the launch template is evaluated up\n at the time of the infrastructure update, even if the launchTemplate wasn't updated.
The vCPU architecture. The default value is X86_64. Valid values are X86_64 and \n ARM64.
This parameter must be set to\n X86_64\n for Windows containers.
The vCPU architecture. The default value is X86_64. Valid values are\n X86_64 and ARM64.
This parameter must be set to\n X86_64\n for Windows containers.
Returns information about the replication instance versions used in the project.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeEngineVersionsMessage": { + "type": "structure", + "members": { + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
Returned EngineVersion objects that describe the replication instance engine versions used in the project.
An optional pagination token provided by a previous request. If this parameter is specified, the response \n includes only records beyond the marker, up to the value specified by MaxRecords.
The version number of the replication instance.
" + } + }, + "Lifecycle": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The lifecycle status of the replication instance version. Valid values are DEPRECATED, \n DEFAULT_VERSION, and ACTIVE.
The release status of the replication instance version.
" + } + }, + "LaunchDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date when the replication instance version became publicly available.
" + } + }, + "AutoUpgradeDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date when the replication instance will be automatically upgraded. This setting only applies \n if the auto-minor-version setting is enabled.
The date when the replication instance version will be deprecated and can no longer be requested.
" + } + }, + "ForceUpgradeDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date when the replication instance will have a version upgrade forced.
" + } + }, + "AvailableUpgrades": { + "target": "com.amazonaws.databasemigrationservice#AvailableUpgradesList", + "traits": { + "smithy.api#documentation": "The list of valid replication instance versions that you can upgrade to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about a replication instance version.
" + } + }, + "com.amazonaws.databasemigrationservice#EngineVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#EngineVersion", + "traits": { + "smithy.api#xmlName": "EngineVersion" + } + } + }, "com.amazonaws.databasemigrationservice#Event": { "type": "structure", "members": { @@ -10225,7 +10353,7 @@ "DatabaseMode": { "target": "com.amazonaws.databasemigrationservice#DatabaseMode", "traits": { - "smithy.api#documentation": "Specifies whether to use default or custom replication behavior for \n PostgreSQL-compatible endpoints. You can use this setting to specify replication \n behavior for endpoints that require additional configuration, such as Babelfish endpoints.
" + "smithy.api#documentation": "Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
" } }, "BabelfishDatabaseName": { diff --git a/codegen/sdk-codegen/aws-models/internetmonitor.json b/codegen/sdk-codegen/aws-models/internetmonitor.json index 7bd1fc71097..2a7c77c9fbe 100644 --- a/codegen/sdk-codegen/aws-models/internetmonitor.json +++ b/codegen/sdk-codegen/aws-models/internetmonitor.json @@ -36,7 +36,7 @@ "PercentOfTotalTrafficImpacted": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The percentage of impact caused by a health event for total traffic globally.
\nFor information about how Internet Monitor calculates impact, see Inside Internet Monitor in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User\n\t\t\tGuide.
" + "smithy.api#documentation": "The impact on total traffic that a health event has, in increased latency or reduced availability. This is the \n\t\t\tpercentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this \n\t\t\tclient location to the Amazon Web Services location using this client network.
\nFor information about how Internet Monitor calculates impact, see How Internet Monitor works in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User\n\t\t\tGuide.
" } }, "PercentOfClientLocationImpacted": { @@ -47,7 +47,7 @@ } }, "traits": { - "smithy.api#documentation": "Measurements about the availability for your application on the internet, calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
\nAvailability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99%\n\t\t\tfor an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
\nFor more information, see How Internet Monitor calculates performance and availability\n\t\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
" + "smithy.api#documentation": "Amazon CloudWatch Internet Monitor calculates measurements about the availability for your application's internet traffic between client locations and Amazon Web Services.\n\t\t\tAmazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
\nAvailability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99%\n\t\t\tfor an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
\nFor more information, see How Internet Monitor calculates performance and availability\n\t\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
" } }, "com.amazonaws.internetmonitor#BadRequestException": { @@ -109,7 +109,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Amazon Virtual Private Clouds (VPCs),\n\t\t\tAmazon CloudFront distributions, and WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to \n\t\t\tthe city-networks, that is, the locations and ASNs (typically internet service providers or ISPs),\n\t\t\twhere clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
\nWhen you create a monitor, you set a maximum limit for the number of city-networks where client traffic is monitored. The city-network maximum \n\t\t\tthat you choose is the limit, but you only pay for the number of city-networks that are actually monitored. You can change the maximum at any time \n\t\t\tby updating your monitor. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
", + "smithy.api#documentation": "Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs,\n\t\t\tNetwork Load Balancers (NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services \n\t\t\tthat are specific to the city-networks. That is, the locations and ASNs (typically internet service providers or ISPs),\n\t\t\twhere clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User \n\t\t\t\t\tGuide.
\nWhen you create a monitor, you choose the percentage of traffic that you want to monitor. You can also set a maximum limit for the \n\t\t\tnumber of city-networks where client traffic is monitored, that caps the total traffic that Internet Monitor monitors. A city-network \n\t\t\tmaximum is the limit of city-networks, but you only pay for the number of city-networks that are actually monitored. You can update your monitor\n\t\t\tat any time to change the percentage of traffic to monitor or the city-networks maximum. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
", "smithy.api#http": { "uri": "/v20210603/Monitors", "method": "POST" @@ -130,7 +130,7 @@ "Resources": { "target": "com.amazonaws.internetmonitor#SetOfARNs", "traits": { - "smithy.api#documentation": "The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
\nYou can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of\n\t\t\tresources.
\nIf you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.
\nThe resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs,\n\t\t\tAmazon CloudFront distributions, or Amazon WorkSpaces directories.
\nYou can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add \n\t\t\tNLBs or WorkSpaces directories together with any other resources.
\nIf you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has \n\t\t\tinternet connectivity.
\nThe maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and \n\t\t\tthe network or ASN, such as an internet service provider (ISP), that clients access the resources through. This limit helps control billing costs.
\nTo learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + "smithy.api#documentation": "The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your \n\t\t\tapplication resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources \n\t\t\tthrough. Setting this limit can help control billing costs.
\nTo learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" } }, "InternetMeasurementsLogDelivery": { @@ -163,13 +163,13 @@ "target": "com.amazonaws.internetmonitor#TrafficPercentageToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.
" + "smithy.api#documentation": "The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks\n\t\t\tmaximum, that limit overrides the traffic percentage that you set.
\nTo learn more, see Choosing an application traffic percentage to monitor\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" } }, "HealthEventsConfig": { "target": "com.amazonaws.internetmonitor#HealthEventsConfig", "traits": { - "smithy.api#documentation": "Defines the health event threshold percentages, for performance score and availability score. Internet Monitor creates a health event when \n\t\t\tthere's an internet issue that affects your application end users where a health score percentage is at or below a set threshold. If you \n\t\t\tdon't set a health event threshold, the default calue is 95%.
" + "smithy.api#documentation": "Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a\n\t\t\thealth event when an internet issue that affects your application end users has a health score percentage that is at or below a \n\t\t\tspecific threshold, and, sometimes, when other criteria are met.
\nIf you don't set a health event threshold, the default value is 95%.
\nFor more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" } } } @@ -264,7 +264,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations,\n\t\t\tand all of the information related to the event by location.
\nThe information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type,\n\t\t\tand so on.
\nInformation rolled up at the global traffic level is also returned, including the impact type and total traffic impact.
", + "smithy.api#documentation": "Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations,\n\t\t\tand all the information related to the event, by location.
\nThe information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs),\n\t\t\tthe event type, and so on.
\nInformation rolled up at the global traffic level is also returned, including the impact type and total traffic impact.
", "smithy.api#http": { "uri": "/v20210603/Monitors/{MonitorName}/HealthEvents/{EventId}", "method": "GET" @@ -357,7 +357,7 @@ "PercentOfTotalTrafficImpacted": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The impact on total traffic that a health event has.
" + "smithy.api#documentation": "The impact on total traffic that a health event has, in increased latency or reduced availability. This is the \n\t\t\tpercentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this \n\t\t\tclient location to the Amazon Web Services location using this client network.
" } }, "ImpactType": { @@ -371,7 +371,7 @@ "target": "com.amazonaws.internetmonitor#Percentage", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The threshold percentage for health events when Amazon CloudWatch Internet Monitor creates a health event.
" + "smithy.api#documentation": "The threshold percentage for a health score that determines, along with other configuration information,\n\t\t\twhen Internet Monitor creates a health event when there's an internet issue that affects your application end users.
" } } } @@ -440,7 +440,7 @@ "Resources": { "target": "com.amazonaws.internetmonitor#SetOfARNs", "traits": { - "smithy.api#documentation": "The resources that have been added for the monitor. Resources are listed by their Amazon Resource Names (ARNs).
", + "smithy.api#documentation": "The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).
", "smithy.api#required": {} } }, @@ -489,7 +489,7 @@ "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and \n\t\t\tthe network or ASN, such as an internet service provider (ISP), that clients access the resources through. This limit helps control billing costs.
\nTo learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + "smithy.api#documentation": "The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your \n\t\t\tapplication resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources \n\t\t\tthrough. This limit can help control billing costs.
\nTo learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" } }, "InternetMeasurementsLogDelivery": { @@ -502,13 +502,13 @@ "target": "com.amazonaws.internetmonitor#TrafficPercentageToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.
" + "smithy.api#documentation": "The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks\n\t\t\tmaximum, that limit overrides the traffic percentage that you set.
\nTo learn more, see Choosing an application traffic percentage to monitor\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" } }, "HealthEventsConfig": { "target": "com.amazonaws.internetmonitor#HealthEventsConfig", "traits": { - "smithy.api#documentation": "The list of health event thresholds. A health event threshold percentage, for performance and availability, determines the level\n\t\t\tof impact at which Amazon CloudWatch Internet Monitor creates a health event when there's an internet issue that affects your application end users.
" + "smithy.api#documentation": "The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration \n\t\t\tinformation, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
\nFor more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" } } } @@ -577,7 +577,7 @@ "PercentOfTotalTrafficImpacted": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The impact on global traffic monitored by this monitor for this health event.
" + "smithy.api#documentation": "The impact on total traffic that a health event has, in increased latency or reduced availability. This is the \n\t\t\tpercentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this \n\t\t\tclient location to the Amazon Web Services location using this client network.
" } }, "ImpactType": { @@ -610,6 +610,14 @@ { "value": "PERFORMANCE", "name": "PERFORMANCE" + }, + { + "value": "LOCAL_AVAILABILITY", + "name": "LOCAL_AVAILABILITY" + }, + { + "value": "LOCAL_PERFORMANCE", + "name": "LOCAL_PERFORMANCE" } ] } @@ -684,10 +692,22 @@ "smithy.api#default": 0, "smithy.api#documentation": "The health event threshold percentage set for performance scores.
" } + }, + "AvailabilityLocalHealthEventsConfig": { + "target": "com.amazonaws.internetmonitor#LocalHealthEventsConfig", + "traits": { + "smithy.api#documentation": "The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
" + } + }, + "PerformanceLocalHealthEventsConfig": { + "target": "com.amazonaws.internetmonitor#LocalHealthEventsConfig", + "traits": { + "smithy.api#documentation": "The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
" + } } }, "traits": { - "smithy.api#documentation": "A complex type for the configuration. Defines the health event threshold percentages, for performance score and availability score. Amazon CloudWatch Internet Monitor creates a health event when \n\t\t\tthere's an internet issue that affects your application end users where a health score percentage is at or below a set threshold. If you \n\t\t\tdon't set a health event threshold, the default value is 95%.
" + "smithy.api#documentation": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event \n\t\t\tfor an overall performance or availability issue, across an application's geographies.
\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds\n\t\t\tfor when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores,\n\t\t\tor both.
\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks,\n\t\t\tin addition to creating an event when an overall score crosses a threshold.
\nIf you don't set a health event threshold, the default value is 95%.
\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event.\n\t\t\tIn addition, you can disable local thresholds, for performance scores, availability scores, or both.
\nFor more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" } }, "com.amazonaws.internetmonitor#ImpactedLocation": { @@ -837,7 +857,7 @@ } }, "traits": { - "smithy.api#documentation": "Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has\n\t\t\tsubstantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By\n\t\t\tapplying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an\n\t\t\testimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a\n\t\t\tperformance score and an availability score.
" + "smithy.api#documentation": "Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has\n\t\t\tsubstantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By\n\t\t\tapplying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an\n\t\t\testimated baseline that's already calculated. To make it easier to see those drops, Internet Monitor reports the information to you in the form of health scores: a\n\t\t\tperformance score and an availability score.
" } }, "com.amazonaws.internetmonitor#InternetMeasurementsLogDelivery": { @@ -913,7 +933,7 @@ "X-Amz-Requested-Operation" ] }, - "smithy.api#documentation": "Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability \n\t\t\tbetween your applications hosted on Amazon Web Services and your end users. It reduces the time it takes for you to diagnose \n\t\t\tinternet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global \n\t\t\tnetworking footprint to calculate a baseline of performance and availability for internet traffic. This \n\t\t\tis the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements \n\t\t\tas a baseline, Internet Monitor raises awareness for you when there are significant problems for your \n\t\t\tend users in the different geographic locations where your application runs.
\nInternet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, \n\t\t\tto easily support using CloudWatch tools with health information for geographies and networks specific to your application.\n\t\t\tInternet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, \n\t\t\tyou also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.
\nTo use Internet Monitor, you create a monitor and associate your application's resources \n\t\t\twith it, VPCs, CloudFront distributions, or WorkSpaces directories, to enable Internet Monitor to know \n\t\t\twhere your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to \n\t\t\tthe locations and networks that communicate with your application.
\nFor more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
", + "smithy.api#documentation": "Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability \n\t\t\tbetween your applications hosted on Amazon Web Services and your end users. It can reduce the time it takes for you to diagnose \n\t\t\tinternet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global \n\t\t\tnetworking footprint to calculate a baseline of performance and availability for internet traffic. This \n\t\t\tis the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements \n\t\t\tas a baseline, Internet Monitor raises awareness for you when there are significant problems for your \n\t\t\tend users in the different geographic locations where your application runs.
\nInternet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, \n\t\t\tto easily support using CloudWatch tools with health information for geographies and networks specific to your application.\n\t\t\tInternet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, \n\t\t\tyou also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.
\nTo use Internet Monitor, you create a monitor and associate your application's resources \n\t\t\twith it - VPCs, NLBs, CloudFront distributions, or WorkSpaces directories - so Internet Monitor can determine \n\t\t\twhere your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to \n\t\t\tthe locations and ASNs (typically, internet service providers or ISPs) that communicate with your application.
\nFor more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
", "smithy.api#title": "Amazon CloudWatch Internet Monitor", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -981,18 +1001,28 @@ ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -1000,19 +1030,35 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ + true, { - "ref": "Region" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", "rules": [ { - "conditions": [], + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], "type": "tree", "rules": [ { @@ -1027,7 +1073,7 @@ { "ref": "PartitionResult" }, - "supportsDualStack" + "supportsFIPS" ] } ] @@ -1035,62 +1081,10 @@ ], "type": "tree", "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, { "conditions": [], "endpoint": { - "url": "https://internetmonitor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, @@ -1100,95 +1094,91 @@ }, { "conditions": [], - "type": "tree", - "rules": [ + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ + "fn": "getAttr", + "argv": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "ref": "PartitionResult" }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://internetmonitor.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "supportsFIPS" ] } ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1349,7 +1339,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network\n\t\t\tcause and status, event start and end time, percentage of total traffic impacted, and status.
\nHealth events that have start times during the time frame that is requested are not included in the list of health events.
\nLists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end time and \n\t\t\tthe status.
\nHealth events that have start times during the time frame that is requested are not included in the list of health events.
\nThe status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED\n\t\tor DISABLED.
The health event threshold percentage set for a local health score.
" + } + }, + "MinTrafficImpact": { + "target": "com.amazonaws.internetmonitor#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a\n\t\t\tthreshold is crossed for a local health score.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event \n\t\t\tfor a local performance or availability issue, when scores cross a threshold for one or more city-networks.
\nDefines the percentages, for performance scores or availability scores, that are the local thresholds\n\t\t\tfor when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage\n\t\t\tof overall traffic that must be impacted by an issue before Internet Monitor creates an event when a\tthreshold is crossed for a local health score.
\nFor more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" + } + }, + "com.amazonaws.internetmonitor#LocalHealthEventsConfigStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ENABLED", + "value": "ENABLED" + }, + { + "name": "DISABLED", + "value": "DISABLED" + } + ] + } + }, "com.amazonaws.internetmonitor#LogDeliveryStatus": { "type": "string", "traits": { @@ -1854,7 +1887,7 @@ "PercentOfTotalTrafficImpacted": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "How much performance impact was caused by a health event for total traffic globally. For performance, this is the percentage of how much latency\n\t\t\tincreased during the event compared to typical performance for your application traffic globally.
\nFor more information, see When Amazon Web Services creates and resolves health\n\t\t\tevents in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + "smithy.api#documentation": "The impact on total traffic that a health event has, in increased latency or reduced availability. This is the \n\t\t\tpercentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this \n\t\t\tclient location to the Amazon Web Services location using this client network.
\nFor more information, see When Amazon Web Services creates and resolves health\n\t\t\tevents in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" } }, "PercentOfClientLocationImpacted": { @@ -1871,7 +1904,7 @@ } }, "traits": { - "smithy.api#documentation": "Measurements about the performance for your application on the internet calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
\nPerformance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for\n\t\t\tan end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.
\nFor more information, see How Internet Monitor calculates performance and availability\n\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + "smithy.api#documentation": "Amazon CloudWatch Internet Monitor calculates measurements about the performance for your application's internet traffic between client locations and Amazon Web Services. \n\t\t\tAmazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
\nPerformance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for\n\t\t\tan end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.
\nFor more information, see How Internet Monitor calculates performance and availability\n\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" } }, "com.amazonaws.internetmonitor#ResourceName": { @@ -2237,7 +2270,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a monitor. You can update a monitor to change the maximum number of city-networks (locations and ASNs or \n\t\t\tinternet service providers), to add or remove resources, \n\t\t\tor to change the status of the monitor. Note that you can't change the name of a monitor.
\nThe city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. \n\t\t\tFor more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
", + "smithy.api#documentation": "Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks \n\t\t\t(locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.
\nThe city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. \n\t\t\tFor more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
", "smithy.api#http": { "uri": "/v20210603/Monitors/{MonitorName}", "method": "PATCH" @@ -2259,7 +2292,7 @@ "ResourcesToAdd": { "target": "com.amazonaws.internetmonitor#SetOfARNs", "traits": { - "smithy.api#documentation": "The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
\nYou can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of\n\t\t\tresources.
\nIf you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet\n\t\t\tconnectivity.
\nThe resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs,\n\t\t\tAmazon CloudFront distributions, or Amazon WorkSpaces directories.
\nYou can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add \n\t\t\tNLBs or WorkSpaces directories together with any other resources.
\nIf you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet\n\t\t\tconnectivity.
\nThe maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from \n\t\t\tand the network or ASN, \n\t\t\tsuch as an internet service provider, that clients access the resources through.
" + "smithy.api#documentation": "The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your \n\t\t\tapplication resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources \n\t\t\tthrough. Setting this limit can help control billing costs.
" } }, "InternetMeasurementsLogDelivery": { @@ -2298,13 +2331,13 @@ "target": "com.amazonaws.internetmonitor#TrafficPercentageToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.
" + "smithy.api#documentation": "The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks\n\t\t\tmaximum, that limit overrides the traffic percentage that you set.
\nTo learn more, see Choosing an application traffic percentage to monitor\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" } }, "HealthEventsConfig": { "target": "com.amazonaws.internetmonitor#HealthEventsConfig", "traits": { - "smithy.api#documentation": "The list of health event thresholds. A health event threshold percentage, for performance and availability, determines when Internet Monitor creates \n\t\t\ta health event when there's an internet issue that affects your application end users.
" + "smithy.api#documentation": "The list of health score thresholds. A threshold percentage for health scores, along with other configuration information,\n\t\t\tdetermines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
\nFor more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" } } } diff --git a/codegen/sdk-codegen/aws-models/medialive.json b/codegen/sdk-codegen/aws-models/medialive.json index 0b0872f6aa1..7c94a0c3cc0 100644 --- a/codegen/sdk-codegen/aws-models/medialive.json +++ b/codegen/sdk-codegen/aws-models/medialive.json @@ -5637,6 +5637,13 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Availability Zone associated with this input device.", + "smithy.api#jsonName": "availabilityZone" + } } }, "traits": { @@ -12788,6 +12795,13 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Availability Zone associated with this input device.", + "smithy.api#jsonName": "availabilityZone" + } } }, "traits": { @@ -23289,6 +23303,13 @@ "smithy.api#documentation": "The settings that you want to apply to the UHD input device.", "smithy.api#jsonName": "uhdDeviceSettings" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Availability Zone you want associated with this input device.", + "smithy.api#jsonName": "availabilityZone" + } } }, "traits": { @@ -23389,6 +23410,13 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Availability Zone associated with this input device.", + "smithy.api#jsonName": "availabilityZone" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/polly.json b/codegen/sdk-codegen/aws-models/polly.json index 895b4dc7c2e..ebc45a63dbd 100644 --- a/codegen/sdk-codegen/aws-models/polly.json +++ b/codegen/sdk-codegen/aws-models/polly.json @@ -689,6 +689,12 @@ "traits": { "smithy.api#enumValue": "nl-BE" } + }, + "fr_BE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-BE" + } } } }, @@ -3401,6 +3407,12 @@ "traits": { "smithy.api#enumValue": "Lisa" } + }, + "Isabelle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Isabelle" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 93043a61c22..075663b36b7 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -40,7 +40,8 @@ } }, "traits": { - "smithy.api#documentation": "Data returned by the DescribeAccountAttributes action.
" + "smithy.api#documentation": "Data returned by the DescribeAccountAttributes action.
", + "smithy.api#output": {} } }, "com.amazonaws.rds#AccountQuota": { @@ -184,7 +185,17 @@ } ], "traits": { - "smithy.api#documentation": "Associates an Identity and Access Management (IAM) role with a DB cluster.
" + "smithy.api#documentation": "Associates an Identity and Access Management (IAM) role with a DB cluster.
", + "smithy.api#examples": [ + { + "title": "To associate an AWS Identity and Access Management (IAM) role with a DB cluster", + "documentation": "The following example associates a role with a DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" + } + } + ] } }, "com.amazonaws.rds#AddRoleToDBClusterMessage": { @@ -210,6 +221,9 @@ "smithy.api#documentation": "The name of the feature for the DB cluster that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#AddRoleToDBInstance": { @@ -235,7 +249,18 @@ } ], "traits": { - "smithy.api#documentation": "Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
\nTo add a role to a DB instance, the status of the DB instance must be available.
This command doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
\nTo add a role to a DB instance, the status of the DB instance must be available.
This command doesn't apply to RDS Custom.
", + "smithy.api#examples": [ + { + "title": "To associate an AWS Identity and Access Management (IAM) role with a DB instance", + "documentation": "The following example adds the role to a DB instance named test-instance.", + "input": { + "DBInstanceIdentifier": "test-instance", + "RoleArn": "arn:aws:iam::111122223333:role/rds-s3-integration-role", + "FeatureName": "S3_INTEGRATION" + } + } + ] } }, "com.amazonaws.rds#AddRoleToDBInstanceMessage": { @@ -262,6 +287,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#AddSourceIdentifierToSubscription": { @@ -281,7 +309,37 @@ } ], "traits": { - "smithy.api#documentation": "Adds a source identifier to an existing RDS event notification subscription.
" + "smithy.api#documentation": "Adds a source identifier to an existing RDS event notification subscription.
", + "smithy.api#examples": [ + { + "title": "To add a source identifier to a subscription", + "documentation": "The following example adds another source identifier to an existing subscription.", + "input": { + "SubscriptionName": "my-instance-events", + "SourceIdentifier": "test-instance-repl" + }, + "output": { + "EventSubscription": { + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "CustSubscriptionId": "my-instance-events", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Enabled": false, + "Status": "modifying", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "SourceIdsList": [ + "test-instance", + "test-instance-repl" + ] + } + } + } + ] } }, "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage": { @@ -303,7 +361,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult": { @@ -346,7 +405,22 @@ } ], "traits": { - "smithy.api#documentation": "Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
\nFor an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.
" + "smithy.api#documentation": "Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
\nFor an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.
", + "smithy.api#examples": [ + { + "title": "To add tags to a resource", + "documentation": "This example adds a tag to an option group.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup", + "Tags": [ + { + "Key": "Staging", + "Value": "LocationDB" + } + ] + } + } + ] } }, "com.amazonaws.rds#AddTagsToResourceMessage": { @@ -368,7 +442,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#AmazonRDSv19": { @@ -474,6 +549,9 @@ { "target": "com.amazonaws.rds#DeleteDBCluster" }, + { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackup" + }, { "target": "com.amazonaws.rds#DeleteDBClusterEndpoint" }, @@ -528,6 +606,9 @@ { "target": "com.amazonaws.rds#DescribeCertificates" }, + { + "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackups" + }, { "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" }, @@ -876,52 +957,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -929,13 +1014,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -945,92 +1039,83 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://rds-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://rds-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] } ], @@ -1039,155 +1124,115 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://rds.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://rds-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://rds.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://rds-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://rds.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://rds.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://rds.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://rds.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1921,7 +1966,31 @@ } ], "traits": { - "smithy.api#documentation": "Applies a pending maintenance action to a resource (for example, to a DB instance).
" + "smithy.api#documentation": "Applies a pending maintenance action to a resource (for example, to a DB instance).
", + "smithy.api#examples": [ + { + "title": "To apply pending maintenance actions", + "documentation": "The following example applies the pending maintenance actions for a DB cluster.", + "input": { + "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", + "ApplyAction": "system-update", + "OptInType": "immediate" + }, + "output": { + "ResourcePendingMaintenanceActions": { + "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", + "PendingMaintenanceActionDetails": [ + { + "Action": "system-update", + "OptInStatus": "immediate", + "CurrentApplyDate": "2021-01-23T01:07:36.100Z", + "Description": "Upgrade to Aurora PostgreSQL 3.3.2" + } + ] + } + } + } + ] } }, "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage": { @@ -1950,7 +2019,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#ApplyPendingMaintenanceActionResult": { @@ -2075,7 +2145,20 @@ } ], "traits": { - "smithy.api#documentation": "Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
\nYou can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
\nFor an overview of CIDR ranges, go to the \n Wikipedia Tutorial.
\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.
\nEnables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
\nYou can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
\nFor an overview of CIDR ranges, go to the \n Wikipedia Tutorial.
\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.
\nCancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.
" + "smithy.api#documentation": "Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.
", + "smithy.api#examples": [ + { + "title": "To cancel a snapshot export to Amazon S3", + "documentation": "The following example cancels an export task in progress that is exporting a snapshot to Amazon S3.", + "input": { + "ExportTaskIdentifier": "my-s3-export-1" + }, + "output": { + "ExportTaskIdentifier": "my-s3-export-1", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot", + "SnapshotTime": "2019-03-24T20:01:09.815Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff", + "Status": "CANCELING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + } + ] } }, "com.amazonaws.rds#CancelExportTaskMessage": { @@ -2519,6 +2625,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#Certificate": { @@ -2623,7 +2732,8 @@ } }, "traits": { - "smithy.api#documentation": "Data returned by the DescribeCertificates action.
" + "smithy.api#documentation": "Data returned by the DescribeCertificates action.
", + "smithy.api#output": {} } }, "com.amazonaws.rds#CertificateNotFoundFault": { @@ -2870,7 +2980,26 @@ } ], "traits": { - "smithy.api#documentation": "Copies the specified DB cluster parameter group.
" + "smithy.api#documentation": "Copies the specified DB cluster parameter group.
", + "smithy.api#examples": [ + { + "title": "To copy a DB cluster parameter group", + "documentation": "This example copies a DB cluster parameter group.", + "input": { + "SourceDBClusterParameterGroupIdentifier": "mydbclusterparametergroup", + "TargetDBClusterParameterGroupIdentifier": "mydbclusterparametergroup-copy", + "TargetDBClusterParameterGroupDescription": "My DB cluster parameter group copy" + }, + "output": { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup-copy", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup-copy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group copy" + } + } + } + ] } }, "com.amazonaws.rds#CopyDBClusterParameterGroupMessage": { @@ -2900,6 +3029,9 @@ "Tags": { "target": "com.amazonaws.rds#TagList" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyDBClusterParameterGroupResult": { @@ -2942,7 +3074,45 @@ } ], "traits": { - "smithy.api#documentation": "Copies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:
\n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" + "smithy.api#documentation": "Copies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:
\n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To copy a DB cluster snapshot", + "documentation": "The following example creates a copy of a DB cluster snapshot, including its tags.", + "input": { + "SourceDBClusterSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16", + "TargetDBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "CopyTags": true + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "myaurora", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-123example", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] } }, "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { @@ -2985,7 +3155,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyDBClusterSnapshotResult": { @@ -3019,7 +3190,26 @@ } ], "traits": { - "smithy.api#documentation": "Copies the specified DB parameter group.
" + "smithy.api#documentation": "Copies the specified DB parameter group.
", + "smithy.api#examples": [ + { + "title": "To copy a DB parameter group", + "documentation": "The following example makes a copy of a DB parameter group.", + "input": { + "SourceDBParameterGroupIdentifier": "mydbpg", + "TargetDBParameterGroupIdentifier": "mydbpgcopy", + "TargetDBParameterGroupDescription": "Copy of mydbpg parameter group" + }, + "output": { + "DBParameterGroup": { + "DBParameterGroupName": "mydbpgcopy", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", + "DBParameterGroupFamily": "mysql5.7", + "Description": "Copy of mydbpg parameter group" + } + } + } + ] } }, "com.amazonaws.rds#CopyDBParameterGroupMessage": { @@ -3051,7 +3241,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyDBParameterGroupResult": { @@ -3094,7 +3285,46 @@ } ], "traits": { - "smithy.api#documentation": "Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.
This command doesn't apply to RDS Custom.
\nFor more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.
This command doesn't apply to RDS Custom.
\nFor more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.
", + "smithy.api#examples": [ + { + "title": "To copy a DB snapshot", + "documentation": "The following example creates a copy of a DB snapshot.", + "input": { + "SourceDBSnapshotIdentifier": "rds:database-mysql-2019-06-06-08-38", + "TargetDBSnapshotIdentifier": "mydbsnapshotcopy" + }, + "output": { + "DBSnapshot": { + "VpcId": "vpc-6594f31c", + "Status": "creating", + "Encrypted": true, + "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38", + "MasterUsername": "admin", + "Iops": 1000, + "Port": 3306, + "LicenseModel": "general-public-license", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy", + "EngineVersion": "5.6.40", + "OptionGroupName": "default:mysql-5-6", + "ProcessorFeatures": [], + "Engine": "mysql", + "StorageType": "io1", + "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "SnapshotType": "manual", + "IAMDatabaseAuthenticationEnabled": false, + "SourceRegion": "us-east-1", + "DBInstanceIdentifier": "database-mysql", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "AvailabilityZone": "us-east-1f", + "PercentProgress": 0, + "AllocatedStorage": 100, + "DBSnapshotIdentifier": "mydbsnapshotcopy" + } + } + } + ] } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { @@ -3155,7 +3385,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyDBSnapshotResult": { @@ -3189,7 +3420,29 @@ } ], "traits": { - "smithy.api#documentation": "Copies the specified option group.
" + "smithy.api#documentation": "Copies the specified option group.
", + "smithy.api#examples": [ + { + "title": "To copy an option group", + "documentation": "The following example makes a copy of an option group.", + "input": { + "SourceOptionGroupIdentifier": "myoptiongroup", + "TargetOptionGroupIdentifier": "new-option-group", + "TargetOptionGroupDescription": "My option group copy" + }, + "output": { + "OptionGroup": { + "Options": [], + "OptionGroupName": "new-option-group", + "MajorEngineVersion": "11.2", + "OptionGroupDescription": "My option group copy", + "AllowsVpcAndNonVpcInstanceMemberships": true, + "EngineName": "oracle-ee", + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group" + } + } + } + ] } }, "com.amazonaws.rds#CopyOptionGroupMessage": { @@ -3221,7 +3474,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyOptionGroupResult": { @@ -3441,6 +3695,9 @@ "Tags": { "target": "com.amazonaws.rds#TagList" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBCluster": { @@ -3508,7 +3765,67 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
\nIf you create an Aurora DB cluster, the request creates an empty cluster. You must\n explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the\n request creates a writer and two reader DB instances for you, each in a different\n Availability Zone.
\nYou can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or\n PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User\n Guide.
You can also use the ReplicationSourceIdentifier parameter to create a\n Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the\n source. For more information about Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
\nIf you create an Aurora DB cluster, the request creates an empty cluster. You must\n explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the\n request creates a writer and two reader DB instances for you, each in a different\n Availability Zone.
\nYou can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or\n PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User\n Guide.
You can also use the ReplicationSourceIdentifier parameter to create a\n Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the\n source. For more information about Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
\nThis action applies only to Aurora DB clusters.
\nCreates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
\nThis action applies only to Aurora DB clusters.
\nThe tags to be assigned to the Amazon RDS resource.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBClusterMessage": { @@ -3891,7 +4241,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBClusterParameterGroup": { @@ -3911,7 +4262,26 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB cluster parameter group.
\nParameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
\nA DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.
\nWhen you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.
\nAfter you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" + "smithy.api#documentation": "Creates a new DB cluster parameter group.
\nParameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
\nA DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.
\nWhen you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.
\nAfter you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To create a DB cluster parameter group", + "documentation": "The following example creates a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group" + }, + "output": { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" + } + } + } + ] } }, "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { @@ -3946,7 +4316,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBClusterParameterGroupResult": { @@ -3997,7 +4368,44 @@ } ], "traits": { - "smithy.api#documentation": "Creates a snapshot of a DB cluster.
\nFor more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" + "smithy.api#documentation": "Creates a snapshot of a DB cluster.
\nFor more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To create a DB cluster snapshot", + "documentation": "The following example creates a DB cluster snapshot.", + "input": { + "DBClusterSnapshotIdentifier": "mydbcluster", + "DBClusterIdentifier": "mydbclustersnapshot" + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 1, + "Status": "creating", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 0, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] } }, "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { @@ -4025,7 +4433,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBClusterSnapshotResult": { @@ -4113,7 +4522,111 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB instance.
\nThe new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.
\nFor more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
\nFor more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "Creates a new DB instance.
\nThe new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.
\nFor more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
\nFor more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a DB instance", + "documentation": "The following example uses the required options to launch a new DB instance.", + "input": { + "DBInstanceIdentifier": "test-mysql-instance", + "AllocatedStorage": 20, + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "MasterUsername": "admin", + "MasterUserPassword": "secret99" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "test-mysql-instance", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "creating", + "MasterUsername": "admin", + "AllocatedStorage": 20, + "PreferredBackupWindow": "12:55-13:25", + "BackupRetentionPeriod": 1, + "DBSecurityGroups": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-12345abc", + "Status": "active" + } + ], + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.mysql5.7", + "ParameterApplyStatus": "in-sync" + } + ], + "DBSubnetGroup": { + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-2ff2ff2f", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ] + }, + "PreferredMaintenanceWindow": "sun:08:07-sun:08:37", + "PendingModifiedValues": { + "MasterUserPassword": "****" + }, + "MultiAZ": false, + "EngineVersion": "5.7.22", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + "OptionGroupMemberships": [ + { + "OptionGroupName": "default:mysql-5-7", + "Status": "in-sync" + } + ], + "PubliclyAccessible": true, + "StorageType": "gp2", + "DbInstancePort": 0, + "StorageEncrypted": false, + "DbiResourceId": "db-5555EXAMPLE44444444EXAMPLE", + "CACertificateIdentifier": "rds-ca-2019", + "DomainMemberships": [], + "CopyTagsToSnapshot": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false, + "DeletionProtection": false, + "AssociatedRoles": [] + } + } + } + ] } }, "com.amazonaws.rds#CreateDBInstanceMessage": { @@ -4484,7 +4997,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBInstanceReadReplica": { @@ -4564,7 +5078,26 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
\nAmazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.
\nYour source DB instance or cluster must have backup retention enabled.
\nCreates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
\nAmazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.
\nYour source DB instance or cluster must have backup retention enabled.
\nThe identifier of the Multi-AZ DB cluster that will act as the source for the read\n replica. Each DB cluster can have up to 15 read replicas.
\nConstraints:
\nMust be the identifier of an existing Multi-AZ DB cluster.
\nCan't be specified if the SourceDBInstanceIdentifier parameter is\n also specified.
The specified DB cluster must have automatic backups enabled, that is, its\n backup retention period must be greater than 0.
\nThe source DB cluster must be in the same Amazon Web Services Region as the read replica.\n Cross-Region replication isn't supported.
\nCreates a new DB parameter group.
\nA DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.
This command doesn't apply to RDS Custom.
\nAfter you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
Creates a new DB parameter group.
\nA DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.
This command doesn't apply to RDS Custom.
\nAfter you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
Creates a new DB security group. DB security groups control access to a DB instance.
\nA DB security group controls access to EC2-Classic DB instances that are not in a VPC.
\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.
\nCreates a new DB security group. DB security groups control access to a DB instance.
\nA DB security group controls access to EC2-Classic DB instances that are not in a VPC.
\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.
\nCreates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.
Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
" + "smithy.api#documentation": "Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
", + "smithy.api#examples": [ + { + "title": "To create a DB subnet group", + "documentation": "The following example creates a DB subnet group called mysubnetgroup using existing subnets.", + "input": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "SubnetIds": [ + "subnet-0a1dc4e1a6f123456", + "subnet-070dd7ecb3aaaaaaa", + "subnet-00f5b198bc0abcdef" + ] + }, + "output": { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup" + } + } + } + ] } }, "com.amazonaws.rds#CreateDBSubnetGroupMessage": { @@ -5294,7 +5949,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBSubnetGroupResult": { @@ -5340,7 +5996,38 @@ } ], "traits": { - "smithy.api#documentation": "Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.
\nYou can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.
For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.
\nFor more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.
\nYou can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.
For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.
\nFor more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.
", + "smithy.api#examples": [ + { + "title": "To create an event subscription", + "documentation": "The following example creates a subscription for backup and recovery events for DB instances in the current AWS account. Notifications are sent to an Amazon Simple Notification Service topic.", + "input": { + "SubscriptionName": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "EventCategories": [ + "backup", + "recovery" + ] + }, + "output": { + "EventSubscription": { + "Status": "creating", + "CustSubscriptionId": "my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustomerAwsId": "123456789012", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SourceType": "db-instance", + "Enabled": true + } + } + } + ] } }, "com.amazonaws.rds#CreateEventSubscriptionMessage": { @@ -5389,7 +6076,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateEventSubscriptionResult": { @@ -5426,7 +6114,30 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.
\nYou can create a global database that is initially empty, and then \n create the primary and secondary DB clusters in the global database.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.
\nThis operation applies only to Aurora DB clusters.
\nCreates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.
\nYou can create a global database that is initially empty, and then \n create the primary and secondary DB clusters in the global database.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.
\nThis operation applies only to Aurora DB clusters.
\nSpecifies whether to enable storage encryption for the new global database cluster.
\nConstraints:
\nCan't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.
Creates a new option group. You can create up to 20 option groups.
\nThis command doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Creates a new option group. You can create up to 20 option groups.
\nThis command doesn't apply to RDS Custom.
", + "smithy.api#examples": [ + { + "title": "To Create an Amazon RDS option group", + "documentation": "The following example creates a new Amazon RDS option group for Oracle MySQL version 8,0 named MyOptionGroup.", + "input": { + "OptionGroupName": "MyOptionGroup", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "OptionGroupDescription": "MySQL 8.0 option group" + }, + "output": { + "OptionGroup": { + "OptionGroupName": "myoptiongroup", + "OptionGroupDescription": "MySQL 8.0 option group", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" + } + } + } + ] } }, "com.amazonaws.rds#CreateOptionGroupMessage": { @@ -5546,7 +6283,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateOptionGroupResult": { @@ -6137,10 +6875,220 @@ } }, "traits": { - "smithy.api#documentation": "Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
\nFor an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
\nFor an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + } + }, + "com.amazonaws.rds#DBClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The user already has a DB cluster with the given identifier.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackup": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The name of the database engine for this automated backup.
" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The VPC ID associated with the DB cluster.
" + } + }, + "DBClusterAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the automated backups.
" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
" + } + }, + "RestoreWindow": { + "target": "com.amazonaws.rds#RestoreWindow" + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The master user name of the automated backup.
" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
" + } + }, + "Region": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region associated with the automated backup.
" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The license model information for this DB cluster automated backup.
" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "A list of status information for an automated backup:
\n\n retained - Automated backups for deleted clusters.
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and \n otherwise false.
" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "The time when the DB cluster was created, in Universal Coordinated Time (UTC).
" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the source DB cluster is encrypted.
" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.
The version of the database engine for the automated backup.
" + } + }, + "DBClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the source DB cluster.
" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The retention period for the automated backups.
" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The engine mode of the database engine for the automated backup.
" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "The Availability Zones where instances in the DB cluster can be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.
" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The port number that the automated backup used for connections.
\nDefault: Inherits from the source DB cluster
\nValid Values: 1150-65535\n
The Amazon Web Services KMS key ID for an automated backup.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The storage type associated with the DB cluster.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The IOPS (I/O operations per second) value for the automated backup.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster \n properties that existed at the time you deleted the source cluster.
" + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackup", + "traits": { + "smithy.api#xmlName": "DBClusterAutomatedBackup" + } + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.
A list of DBClusterAutomatedBackup backups.
No automated backup for this DB cluster was found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 } }, - "com.amazonaws.rds#DBClusterAlreadyExistsFault": { + "com.amazonaws.rds#DBClusterAutomatedBackupQuotaExceededFault": { "type": "structure", "members": { "message": { @@ -6149,10 +7097,10 @@ }, "traits": { "aws.protocols#awsQueryError": { - "code": "DBClusterAlreadyExistsFault", + "code": "DBClusterAutomatedBackupQuotaExceededFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "The user already has a DB cluster with the given identifier.
", + "smithy.api#documentation": "The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated \n backups. The retained automated backups quota is the same as your DB cluster quota.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6227,7 +7175,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.
Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.
Contains the details of the endpoints associated with the cluster\n and matching any filter conditions.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#DBClusterEndpointNotFoundFault": { @@ -6505,7 +7457,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeDBClusters action.
Contains the result of a successful invocation of the DescribeDBClusters action.
The Amazon Resource Name (ARN) for the DB cluster snapshot.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot.
" } }, "SourceDBClusterSnapshotArn": { @@ -6917,6 +7871,12 @@ "traits": { "smithy.api#documentation": "The storage type associated with the DB cluster snapshot.
\nThis setting is only for Aurora DB clusters.
" } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from.
" + } } }, "traits": { @@ -7015,7 +7975,8 @@ } }, "traits": { - "smithy.api#documentation": "Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
" + "smithy.api#documentation": "The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
" } }, "Region": { @@ -7814,7 +8776,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The customer id of the instance that is/was associated with the automated backup.
" + "smithy.api#documentation": "The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
" } }, "RestoreWindow": { @@ -7833,7 +8795,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Provides a list of status information for an automated backup:
\n\n active - automated backups for current instances
\n retained - automated backups for deleted instances
\n creating - automated backups that are waiting\n for the first automated snapshot to be available.
Provides a list of status information for an automated backup:
\n\n active - Automated backups for current instances.
\n retained - Automated backups for deleted instances.
\n creating - Automated backups that are waiting for the first automated snapshot to be available.
The license model of an automated backup.
" + "smithy.api#documentation": "The master user name of an automated backup.
" } }, "Engine": { @@ -7996,7 +8958,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.
Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.
The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB Instance quota.
", + "smithy.api#documentation": "The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB instance quota.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8082,7 +9045,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeDBInstances action.
Contains the result of a successful invocation of the DescribeDBInstances action.
Contains the result of a successful invocation of the DescribeDBParameterGroups action.
Contains the result of a successful invocation of the DescribeDBParameterGroups action.
Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
Contains the result of a successful invocation of the DescribeDBSnapshots action.
Contains the result of a successful invocation of the DescribeDBSnapshots action.
Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.
\nIf you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are\n terminated and read replicas are promoted to standalone instances.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" + "smithy.api#documentation": "The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.
\nIf you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are\n terminated and read replicas are promoted to standalone instances.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster", + "documentation": "The following example deletes the DB cluster named mycluster and takes a final snapshot named mycluster-final-snapshot. The status of the DB cluster is available while the snapshot is being taken. ", + "input": { + "DBClusterIdentifier": "mycluster", + "SkipFinalSnapshot": false, + "FinalDBSnapshotIdentifier": "mycluster-final-snapshot" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 20, + "AvailabilityZones": [ + "eu-central-1b", + "eu-central-1c", + "eu-central-1a" + ], + "BackupRetentionPeriod": 7, + "DBClusterIdentifier": "mycluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default-vpc-aa11bb22", + "Status": "available" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon \n Resource Name (ARN) of the automated backups.
The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult": { + "type": "structure", + "members": { + "DBClusterAutomatedBackup": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#DeleteDBClusterEndpoint": { @@ -9873,7 +10919,32 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nDeletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nThe DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.
Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.
Constraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nA value that indicates whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.
" + } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBClusterParameterGroup": { @@ -9933,7 +11014,16 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" + "smithy.api#documentation": "Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster parameter group", + "documentation": "The following example deletes the specified DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup" + } + } + ] } }, "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { @@ -9948,7 +11038,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBClusterResult": { @@ -9979,7 +11070,43 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
\nThe DB cluster snapshot must be in the available state to be\n deleted.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" + "smithy.api#documentation": "Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
\nThe DB cluster snapshot must be in the available state to be\n deleted.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster snapshot", + "documentation": "", + "input": { + "DBClusterSnapshotIdentifier": "mydbclustersnapshot" + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] } }, "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { @@ -9994,7 +11121,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBClusterSnapshotResult": { @@ -10037,7 +11165,24 @@ } ], "traits": { - "smithy.api#documentation": "The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:
\nThe DB cluster is a read replica of another Amazon Aurora DB cluster.
\nThe DB instance is the only instance in the DB cluster.
\nTo delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.
The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:
\nThe DB cluster is a read replica of another Amazon Aurora DB cluster.
\nThe DB instance is the only instance in the DB cluster.
\nTo delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
Parameter input for the DeleteDBInstanceAutomatedBackup operation.
Parameter input for the DeleteDBInstanceAutomatedBackup operation.
Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
" + "smithy.api#documentation": "Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
", + "smithy.api#examples": [ + { + "title": "To delete a DB parameter group", + "documentation": "The following example deletes a DB parameter group.", + "input": { + "DBParameterGroupName": "mydbparametergroup" + } + } + ] } }, "com.amazonaws.rds#DeleteDBParameterGroupMessage": { @@ -10168,7 +11358,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBProxy": { @@ -10286,7 +11477,16 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a DB security group.
\nThe specified DB security group must not be associated with any DB instances.
\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.
\nDeletes a DB security group.
\nThe specified DB security group must not be associated with any DB instances.
\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.
\nDeletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.
\nThe DB snapshot must be in the available state to be deleted.
Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.
\nThe DB snapshot must be in the available state to be deleted.
Deletes a DB subnet group.
\nThe specified database subnet group must not be associated with any DB instances.
\nDeletes a DB subnet group.
\nThe specified database subnet group must not be associated with any DB instances.
\nDeletes an RDS event notification subscription.
" + "smithy.api#documentation": "Deletes an RDS event notification subscription.
", + "smithy.api#examples": [ + { + "title": "To delete an event subscription", + "documentation": "The following example deletes the specified event subscription.", + "input": { + "SubscriptionName": "my-instance-events" + }, + "output": { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "CustomerAwsId": "123456789012", + "Enabled": false, + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "deleting" + } + } + } + ] } }, "com.amazonaws.rds#DeleteEventSubscriptionMessage": { @@ -10420,7 +11697,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteEventSubscriptionResult": { @@ -10451,7 +11729,29 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.
\nThis action only applies to Aurora DB clusters.
\nDeletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.
\nThis action only applies to Aurora DB clusters.
\nDeletes an existing option group.
" + "smithy.api#documentation": "Deletes an existing option group.
", + "smithy.api#examples": [ + { + "title": "To delete an option group", + "documentation": "The following example deletes the specified option group.", + "input": { + "OptionGroupName": "myoptiongroup" + } + } + ] } }, "com.amazonaws.rds#DeleteOptionGroupMessage": { @@ -10509,7 +11821,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeregisterDBProxyTargets": { @@ -10587,14 +11900,100 @@ "target": "com.amazonaws.rds#AccountAttributesMessage" }, "traits": { - "smithy.api#documentation": "Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
\nThis command doesn't take any parameters.
" + "smithy.api#documentation": "Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
\nThis command doesn't take any parameters.
", + "smithy.api#examples": [ + { + "title": "To describe account attributes", + "documentation": "The following example retrieves the attributes for the current AWS account.", + "output": { + "AccountQuotas": [ + { + "Max": 40, + "Used": 4, + "AccountQuotaName": "DBInstances" + }, + { + "Max": 40, + "Used": 0, + "AccountQuotaName": "ReservedDBInstances" + }, + { + "Max": 100000, + "Used": 40, + "AccountQuotaName": "AllocatedStorage" + }, + { + "Max": 25, + "Used": 0, + "AccountQuotaName": "DBSecurityGroups" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "AuthorizationsPerDBSecurityGroup" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBParameterGroups" + }, + { + "Max": 100, + "Used": 3, + "AccountQuotaName": "ManualSnapshots" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "EventSubscriptions" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBSubnetGroups" + }, + { + "Max": 20, + "Used": 1, + "AccountQuotaName": "OptionGroups" + }, + { + "Max": 20, + "Used": 6, + "AccountQuotaName": "SubnetsPerDBSubnetGroup" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "ReadReplicasPerMaster" + }, + { + "Max": 40, + "Used": 1, + "AccountQuotaName": "DBClusters" + }, + { + "Max": 50, + "Used": 0, + "AccountQuotaName": "DBClusterParameterGroups" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "DBClusterRoles" + } + ] + } + } + ] } }, "com.amazonaws.rds#DescribeAccountAttributesMessage": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeBlueGreenDeployments": { @@ -10724,7 +12123,63 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterAutomatedBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Displays backups for both current and deleted DB clusters. For example, use this operation to find details \n about automated backups for previously deleted clusters. Current clusters are returned for both the \n DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.
All parameters are optional.
" + } + }, + "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage": { + "type": "structure", + "members": { + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.
" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must\n match the identifier of an existing DB cluster. It returns information from the\n specific DB cluster's automated backup. This parameter isn't case-sensitive.
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "A filter that specifies which resources to return based on status.
\nSupported filters are the following:
\n\n status\n
\n retained - Automated backups for deleted clusters and after backup replication is stopped.
\n db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster automated backups identified by these ARNs.
\n db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords \n value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.
Returns information about backtracks for a DB cluster.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nThis action only applies to Aurora MySQL DB clusters.
\nReturns information about endpoints for an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nAn optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To describe DB cluster parameter groups", + "documentation": "The following example retrieves details for your DB cluster parameter groups.", + "output": { + "DBClusterParameterGroups": [ + { + "DBClusterParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default cluster parameter group for aurora-mysql5.7", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7" + }, + { + "DBClusterParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default cluster parameter group for aurora-postgresql9.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6" + }, + { + "DBClusterParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default cluster parameter group for aurora5.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6" + }, + { + "DBClusterParameterGroupName": "mydbclusterpg", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg" + }, + { + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10902,7 +12464,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusterParameters": { @@ -10920,6 +12483,46 @@ ], "traits": { "smithy.api#documentation": "Returns the detailed parameter list for a particular DB cluster parameter group.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To describe the parameters in a DB cluster parameter group", + "documentation": "The following example retrieves details about the parameters in a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterpg" + }, + "output": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + }, + { + "ParameterName": "aurora_lab_mode", + "ParameterValue": "0", + "Description": "Enables new features in the Aurora engine.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10964,7 +12567,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes": { @@ -10981,7 +12585,29 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
\nWhen sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
\nWhen sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
Returns information about DB cluster snapshots. This API action supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To describe a DB cluster snapshot for a DB cluster", + "documentation": "The following example retrieves the details for the DB cluster snapshots for the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusterSnapshots": [ + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + }, + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-20T09:16:26.569Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "automated", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16", + "IAMDatabaseAuthenticationEnabled": false + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11213,10 +12903,17 @@ "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.
\nYou can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
" } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "A specific DB cluster resource ID to describe.
" + } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusters": { @@ -11234,6 +12931,100 @@ ], "traits": { "smithy.api#documentation": "Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
", + "smithy.api#examples": [ + { + "title": "To describe a DB cluster", + "documentation": "The following example retrieves the details of the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusters": [ + { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydbcluster", + "DBClusterIdentifier": "mydbcluster", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "available", + "EarliestRestorableTime": "2019-06-19T09:16:28.210Z", + "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MultiAZ": true, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LatestRestorableTime": "2019-06-20T22:38:14.908Z", + "Port": 3306, + "MasterUsername": "myadmin", + "PreferredBackupWindow": "09:09-09:39", + "PreferredMaintenanceWindow": "sat:04:09-sat:04:39", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "dbinstance3", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance1", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance2", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster-us-east-1b", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "HostedZoneId": "Z2R2ITUGPM61AM", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11406,7 +13197,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBEngineVersions": { @@ -11419,6 +13211,42 @@ }, "traits": { "smithy.api#documentation": "Returns a list of the available DB engines.
", + "smithy.api#examples": [ + { + "title": "To describe the DB engine versions for the MySQL DB engine", + "documentation": "The following example displays details about each of the DB engine versions for the specified DB engine.", + "input": { + "Engine": "mysql" + }, + "output": { + "DBEngineVersions": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.33", + "DBParameterGroupFamily": "mysql5.7", + "DBEngineDescription": "MySQL Community Edition", + "DBEngineVersionDescription": "MySQL 5.7.33", + "ValidUpgradeTarget": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.34", + "Description": "MySQL 5.7.34", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + { + "Engine": "mysql", + "EngineVersion": "5.7.36", + "Description": "MySQL 5.7.36", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + } + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11491,6 +13319,9 @@ "smithy.api#documentation": "A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups": { @@ -11508,6 +13339,43 @@ ], "traits": { "smithy.api#documentation": "Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.
All parameters are optional.
", + "smithy.api#examples": [ + { + "title": "To describe the automated backups for a DB instance", + "documentation": "The following example displays details about the automated backups for the specified DB instance. The details include replicated automated backups in other AWS Regions.", + "input": { + "DBInstanceIdentifier": "new-orcl-db" + }, + "output": { + "DBInstanceAutomatedBackups": [ + { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": { + "EarliestTime": "2020-12-07T21:05:20.939Z", + "LatestTime": "2020-12-07T21:05:20.939Z" + }, + "AllocatedStorage": 20, + "Status": "replicating", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 14, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11528,13 +13396,13 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance' automated backup. This parameter isn't case-sensitive.
" + "smithy.api#documentation": "(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance's automated backup. This parameter isn't case-sensitive.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "A filter that specifies which resources to return based on status.
\nSupported filters are the following:
\n\n status\n
\n active - automated backups for current instances
\n retained - automated backups for deleted instances and after backup replication is stopped
\n creating - automated backups that are waiting for the first automated snapshot to be available
\n db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance automated backups identified by these ARNs.
\n dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
" + "smithy.api#documentation": "A filter that specifies which resources to return based on status.
\nSupported filters are the following:
\n\n status\n
\n active - Automated backups for current instances.
\n creating - Automated backups that are waiting for the first automated snapshot to be available.
\n retained - Automated backups for deleted instances and after backup replication is stopped.
\n db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance automated backups identified by these ARNs.
\n dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
" } }, "MaxRecords": { @@ -11557,7 +13425,8 @@ } }, "traits": { - "smithy.api#documentation": "Parameter input for DescribeDBInstanceAutomatedBackups.
" + "smithy.api#documentation": "Parameter input for DescribeDBInstanceAutomatedBackups.
", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBInstances": { @@ -11575,6 +13444,31 @@ ], "traits": { "smithy.api#documentation": "Describes provisioned RDS instances. This API supports pagination.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
\nReturns a list of DB log files for the DB instance.
\nThis command doesn't apply to RDS Custom.
", + "smithy.api#examples": [ + { + "title": "To describe the log files for a DB instance", + "documentation": "The following example retrieves details about the log files for the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" + }, + "output": { + "DescribeDBLogFiles": [ + { + "Size": 0, + "LastWritten": 1533060000000, + "LogFileName": "error/mysql-error-running.log" + }, + { + "Size": 2683, + "LastWritten": 1532994300000, + "LogFileName": "error/mysql-error-running.log.0" + }, + { + "Size": 107, + "LastWritten": 1533057300000, + "LogFileName": "error/mysql-error-running.log.18" + }, + { + "Size": 13105, + "LastWritten": 1532991000000, + "LogFileName": "error/mysql-error-running.log.23" + }, + { + "Size": 0, + "LastWritten": 1533061200000, + "LogFileName": "error/mysql-error.log" + }, + { + "Size": 3519, + "LastWritten": 1532989252000, + "LogFileName": "mysqlUpgrade" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11856,7 +13794,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBLogFilesResponse": { @@ -11895,6 +13834,40 @@ ], "traits": { "smithy.api#documentation": "Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.
Returns the detailed parameter list for a particular DB parameter group.
", + "smithy.api#examples": [ + { + "title": "To describe the parameters in a DB parameter group", + "documentation": "The following example retrieves the details of the specified DB parameter group.", + "input": { + "DBParameterGroupName": "mydbpg" + }, + "output": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + }, + { + "ParameterName": "auto_generate_certs", + "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11992,6 +13999,9 @@ "smithy.api#documentation": "An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.
\nReturns a list of DB snapshot attribute names and values for a manual DB snapshot.
\nWhen sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
\nWhen sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
Returns information about DB snapshots. This API action supports pagination.
", + "smithy.api#examples": [ + { + "title": "To describe a DB snapshot for a DB instance", + "documentation": "The following example retrieves the details of a DB snapshot for a DB instance.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshots": [ + { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "mysqldb", + "SnapshotCreateTime": "2018-02-08T22:28:08.598Z", + "Engine": "mysql", + "AllocatedStorage": 20, + "Status": "available", + "Port": 3306, + "AvailabilityZone": "us-east-1f", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2018-02-08T22:24:55.973Z", + "MasterUsername": "mysqladmin", + "EngineVersion": "5.6.37", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12645,7 +14727,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBSubnetGroups": { @@ -12663,6 +14746,53 @@ ], "traits": { "smithy.api#documentation": "Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
\nFor an overview of CIDR ranges, go to the \n Wikipedia Tutorial.
", + "smithy.api#examples": [ + { + "title": "To describe a DB subnet group", + "documentation": "The following example retrieves the details of the specified DB subnet group.", + "output": { + "DBSubnetGroups": [ + { + "DBSubnetGroupName": "mydbsubnetgroup", + "DBSubnetGroupDescription": "My DB Subnet Group", + "VpcId": "vpc-971c12ee", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-d8c8e7f4", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-718fdc7d", + "SubnetAvailabilityZone": { + "Name": "us-east-1f" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-cbc8e7e7", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0ccde220", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12700,7 +14830,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParameters": { @@ -12712,7 +14843,33 @@ "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult" }, "traits": { - "smithy.api#documentation": "Returns the default engine and system parameter information for the cluster database engine.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "Returns the default engine and system parameter information for the cluster database engine.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe the default engine and system parameter information for the Aurora database engine", + "documentation": "The following example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility.", + "input": { + "DBParameterGroupFamily": "aurora-mysql5.7" + }, + "output": { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "aurora_load_from_s3_role", + "Description": "IAM role ARN used to load data from AWS S3", + "Source": "engine-default", + "ApplyType": "dynamic", + "DataType": "string", + "IsModifiable": true, + "SupportedEngineModes": [ + "provisioned" + ] + } + ] + } + } + } + ] } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { @@ -12745,7 +14902,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult": { @@ -12769,6 +14927,30 @@ }, "traits": { "smithy.api#documentation": "Returns the default engine and system parameter information for the specified database engine.
", + "smithy.api#examples": [ + { + "title": "To describe the default engine and system parameter information for the database engine", + "documentation": "The following example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.", + "input": { + "DBParameterGroupFamily": "mysql5.7" + }, + "output": { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false + } + ] + } + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "EngineDefaults.Marker", @@ -12807,7 +14989,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeEngineDefaultParametersResult": { @@ -12830,7 +15013,76 @@ "target": "com.amazonaws.rds#EventCategoriesMessage" }, "traits": { - "smithy.api#documentation": "Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .
" + "smithy.api#documentation": "Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .
", + "smithy.api#examples": [ + { + "title": "To describe event categories", + "documentation": "The following example retrieves details about the event categories for all available event sources.", + "input": { + "SourceType": "", + "Filters": [] + }, + "output": { + "EventCategoriesMapList": [ + { + "SourceType": "db-instance", + "EventCategories": [ + "deletion", + "read replica", + "failover", + "restoration", + "maintenance", + "low storage", + "configuration change", + "backup", + "creation", + "availability", + "recovery", + "failure", + "backtrack", + "notification" + ] + }, + { + "SourceType": "db-security-group", + "EventCategories": [ + "configuration change", + "failure" + ] + }, + { + "SourceType": "db-parameter-group", + "EventCategories": [ + "configuration change" + ] + }, + { + "SourceType": "db-snapshot", + "EventCategories": [ + "deletion", + "creation", + "restoration", + "notification" + ] + }, + { + "SourceType": "db-cluster", + "EventCategories": [ + "failover", + "failure", + "notification" + ] + }, + { + "SourceType": "db-cluster-snapshot", + "EventCategories": [ + "backup" + ] + } + ] + } + } + ] } }, "com.amazonaws.rds#DescribeEventCategoriesMessage": { @@ -12850,7 +15102,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeEventSubscriptions": { @@ -12868,6 +15121,30 @@ ], "traits": { "smithy.api#documentation": "Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.
\nFor more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.
\nBy default, RDS returns events that were generated in the past hour.
\nReturns information about a snapshot or cluster export to Amazon S3. This API operation supports\n pagination.
", + "smithy.api#examples": [ + { + "title": "To describe snapshot export tasks", + "documentation": "The following example returns information about snapshot exports to Amazon S3.", + "output": { + "ExportTasks": [ + { + "ExportTaskIdentifier": "test-snapshot-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot", + "SnapshotTime": "2020-03-02T18:26:28.163Z", + "TaskStartTime": "2020-03-02T18:57:56.896Z", + "TaskEndTime": "2020-03-02T19:10:31.985Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "COMPLETE", + "PercentProgress": 100, + "TotalExtractedDataInGB": 0 + }, + { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "SnapshotTime": "2020-03-27T20:48:42.023Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "STARTING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13050,6 +15399,9 @@ "smithy.api#documentation": "The type of source for the export.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeGlobalClusters": { @@ -13067,6 +15419,27 @@ ], "traits": { "smithy.api#documentation": "Returns information about Aurora global database clusters. This API supports pagination.
\nFor more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nAn optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.
Describes all available options.
", + "smithy.api#examples": [ + { + "title": "To describe all available options", + "documentation": "The following example lists the options for an RDS for MySQL version 8.0 DB instance.", + "input": { + "EngineName": "mysql", + "MajorEngineVersion": "8.0" + }, + "output": { + "OptionGroupOptions": [ + { + "Name": "MARIADB_AUDIT_PLUGIN", + "Description": "MariaDB Audit Plugin", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "MinimumRequiredMinorEngineVersion": "25", + "PortRequired": false, + "OptionsDependedOn": [], + "OptionsConflictsWith": [], + "Persistent": false, + "Permanent": false, + "RequiresAutoMinorEngineVersionUpgrade": false, + "VpcOnly": false, + "OptionGroupOptionSettings": [ + { + "SettingName": "SERVER_AUDIT_INCL_USERS", + "SettingDescription": "Include specified users", + "ApplyType": "DYNAMIC", + "IsModifiable": true, + "IsRequired": false, + "MinimumEngineVersionPerAllowedValue": [] + }, + { + "SettingName": "SERVER_AUDIT_EXCL_USERS", + "SettingDescription": "Exclude specified users", + "ApplyType": "DYNAMIC", + "IsModifiable": true, + "IsRequired": false, + "MinimumEngineVersionPerAllowedValue": [] + } + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13158,7 +15580,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeOptionGroups": { @@ -13176,6 +15599,29 @@ ], "traits": { "smithy.api#documentation": "Describes the available option groups.
", + "smithy.api#examples": [ + { + "title": "To describe the available option groups", + "documentation": "The following example lists the options groups for an Oracle Database 19c instance.", + "input": { + "EngineName": "oracle-ee", + "MajorEngineVersion": "19" + }, + "output": { + "OptionGroupsList": [ + { + "OptionGroupName": "default:oracle-ee-19", + "OptionGroupDescription": "Default option group for oracle-ee 19", + "EngineName": "oracle-ee", + "MajorEngineVersion": "19", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13225,7 +15671,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeOrderableDBInstanceOptions": { @@ -13238,6 +15685,50 @@ }, "traits": { "smithy.api#documentation": "Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
", + "smithy.api#examples": [ + { + "title": "To describe orderable DB instance options", + "documentation": "The following example retrieves details about the orderable options for a DB instances running the MySQL DB engine.", + "input": { + "Engine": "mysql" + }, + "output": { + "OrderableDBInstanceOptions": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.33", + "DBInstanceClass": "db.m4.10xlarge", + "LicenseModel": "general-public-license", + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + }, + { + "Name": "us-east-1e" + }, + { + "Name": "us-east-1f" + } + ], + "MultiAZCapable": true, + "ReadReplicaCapable": true, + "Vpc": true, + "SupportsStorageEncryption": true, + "StorageType": "gp2" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13306,7 +15797,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribePendingMaintenanceActions": { @@ -13324,6 +15816,25 @@ ], "traits": { "smithy.api#documentation": "Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
", + "smithy.api#examples": [ + { + "title": "To list resources with at least one pending maintenance action", + "documentation": "The following example lists the pending maintenace action for a DB instance.", + "output": { + "PendingMaintenanceActions": [ + { + "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1", + "PendingMaintenanceActionDetails": [ + { + "Action": "system-update", + "Description": "Upgrade to Aurora PostgreSQL 2.4.2" + } + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13361,7 +15872,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeReservedDBInstances": { @@ -13379,6 +15891,39 @@ ], "traits": { "smithy.api#documentation": "Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
", + "smithy.api#examples": [ + { + "title": "To describe reserved DB instances", + "documentation": "The following example retrieves details about any reserved DB instances in the current AWS account.", + "output": { + "ReservedDBInstances": [ + { + "ReservedDBInstanceId": "myreservedinstance", + "ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456", + "DBInstanceClass": "db.t3.micro", + "StartTime": "2020-06-01T13:44:21.436Z", + "Duration": 31536000, + "FixedPrice": 0, + "UsagePrice": 0, + "CurrencyCode": "USD", + "DBInstanceCount": 1, + "ProductDescription": "sqlserver-ex(li)", + "OfferingType": "No Upfront", + "MultiAZ": false, + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.014, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance", + "LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13458,7 +16003,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeReservedDBInstancesOfferings": { @@ -13476,6 +16022,36 @@ ], "traits": { "smithy.api#documentation": "Lists available reserved DB instance offerings.
", + "smithy.api#examples": [ + { + "title": "To describe reserved DB instance offerings", + "documentation": "The following example retrieves details about reserved DB instance options for RDS for Oracle.", + "input": { + "ProductDescription": "oracle" + }, + "output": { + "ReservedDBInstancesOfferings": [ + { + "CurrencyCode": "USD", + "UsagePrice": 0, + "ProductDescription": "oracle-se2(li)", + "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8", + "MultiAZ": true, + "DBInstanceClass": "db.m4.xlarge", + "OfferingType": "Partial Upfront", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.594, + "RecurringChargeFrequency": "Hourly" + } + ], + "FixedPrice": 4089, + "Duration": 31536000 + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13543,7 +16119,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeSourceRegions": { @@ -13556,6 +16133,145 @@ }, "traits": { "smithy.api#documentation": "Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.
\nUse this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.
\nTo return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.
This command doesn't apply to RDS Custom.
" + "smithy.api#documentation": "You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.
This command doesn't apply to RDS Custom.
", + "smithy.api#examples": [ + { + "title": "To describe valid modifications for a DB instance", + "documentation": "The following example retrieves details about the valid modifications for the specified DB instance.", + "input": { + "DBInstanceIdentifier": "database-test1" + }, + "output": { + "ValidDBInstanceModificationsMessage": { + "Storage": [ + { + "StorageType": "gp2", + "StorageSize": [ + { + "From": 20, + "To": 20, + "Step": 1 + }, + { + "From": 22, + "To": 6144, + "Step": 1 + } + ] + } + ] + } + } + } + ] } }, "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { @@ -13628,7 +16375,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult": { @@ -13786,6 +16534,17 @@ ], "traits": { "smithy.api#documentation": "Downloads all or a portion of the specified log file, up to 1 MB in size.
\nThis command doesn't apply to RDS Custom.
", + "smithy.api#examples": [ + { + "title": "To download a DB log file", + "documentation": "The following example downloads only the latest part of your log file.", + "input": { + "DBInstanceIdentifier": "test-instance", + "LogFileName": "log.txt" + }, + "output": {} + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13852,7 +16611,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#EC2SecurityGroup": { @@ -14088,7 +16848,8 @@ } }, "traits": { - "smithy.api#documentation": "Data returned from the DescribeEventCategories operation.
Data returned from the DescribeEventCategories operation.
Data returned by the DescribeEventSubscriptions action.
" + "smithy.api#documentation": "Data returned by the DescribeEventSubscriptions action.
", + "smithy.api#output": {} } }, "com.amazonaws.rds#EventsMessage": { @@ -14232,7 +16994,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeEvents action.
Contains the result of a successful invocation of the DescribeEvents action.
Information about an export of a snapshot or cluster to Amazon S3.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#FailoverDBCluster": { @@ -14441,7 +17207,20 @@ } ], "traits": { - "smithy.api#documentation": "Forces a failover for a DB cluster.
\nFor an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nFor a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nAn Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.
\nTo simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" + "smithy.api#documentation": "Forces a failover for a DB cluster.
\nFor an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nFor a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nAn Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.
\nTo simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To perform a failover for a DB cluster", + "documentation": "This example performs a failover for the specified DB cluster to the specified DB instance.", + "input": { + "DBClusterIdentifier": "myaurorainstance-cluster", + "TargetDBInstanceIdentifier": "myaurorareplica" + }, + "output": { + "DBCluster": {} + } + } + ] } }, "com.amazonaws.rds#FailoverDBClusterMessage": { @@ -14462,7 +17241,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#FailoverDBClusterResult": { @@ -14519,6 +17299,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#FailoverGlobalClusterResult": { @@ -14828,6 +17611,9 @@ "smithy.api#documentation": "The list of global clusters returned by this request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#IAMAuthMode": { @@ -15044,6 +17830,23 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterAutomatedBackupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The automated backup is in an invalid state. \n For example, this automated backup is associated with an active cluster.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.rds#InvalidDBClusterCapacityFault": { "type": "structure", "members": { @@ -15514,7 +18317,28 @@ } ], "traits": { - "smithy.api#documentation": "Lists all tags on an Amazon RDS resource.
\nFor an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Lists all tags on an Amazon RDS resource.
\nFor an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.
", + "smithy.api#examples": [ + { + "title": "To list tags on an Amazon RDS resource", + "documentation": "The following example lists all tags on a DB instance.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:orcl1" + }, + "output": { + "TagList": [ + { + "Key": "Environment", + "Value": "test" + }, + { + "Key": "Name", + "Value": "MyDatabase" + } + ] + } + } + ] } }, "com.amazonaws.rds#ListTagsForResourceMessage": { @@ -15535,7 +18359,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#LocalWriteForwardingStatus": { @@ -15753,7 +18578,28 @@ } ], "traits": { - "smithy.api#documentation": "Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.
\nBy using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.
\nYou might need to override the default certificate in the following situations:
\nYou already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified Amazon Web Services Region.
\nRDS has already moved to a new default CA certificate for the specified Amazon Web Services\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.
\nFor more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
\nFor more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.
\nBy using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.
\nYou might need to override the default certificate in the following situations:
\nYou already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified Amazon Web Services Region.
\nRDS has already moved to a new default CA certificate for the specified Amazon Web Services\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.
\nFor more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
\nFor more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
", + "smithy.api#examples": [ + { + "title": "To temporarily override the system-default SSL/TLS certificate for new DB instances", + "documentation": "The following example temporarily overrides the system-default SSL/TLS certificate for new DB instances.", + "input": { + "CertificateIdentifier": "rds-ca-2019" + }, + "output": { + "Certificate": { + "CertificateIdentifier": "rds-ca-2019", + "CertificateType": "CA", + "Thumbprint": "EXAMPLE123456789012", + "ValidFrom": "2019-09-19T18:16:53Z", + "ValidTill": "2024-08-22T17:08:50Z", + "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2019", + "CustomerOverride": true, + "CustomerOverrideValidTill": "2024-08-22T17:08:50Z" + } + } + } + ] } }, "com.amazonaws.rds#ModifyCertificatesMessage": { @@ -15771,6 +18617,9 @@ "smithy.api#documentation": "A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyCertificatesResult": { @@ -15804,7 +18653,24 @@ } ], "traits": { - "smithy.api#documentation": "Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
\nAurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.
\nFor more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nIf you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This action only applies to Aurora Serverless v1 DB clusters.
\nSet the capacity of an Aurora Serverless v1 DB cluster to a specific value.
\nAurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.
\nFor more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nIf you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This action only applies to Aurora Serverless v1 DB clusters.
\nThe action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
The availability status to be assigned to the CEV. Valid values are as follows:
\nYou can use this CEV to create a new RDS Custom DB instance.
\nYou can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.
\nYou can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" + "smithy.api#documentation": "Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To modify a DB cluster", + "documentation": "The following example changes the master user password for the DB cluster named cluster-2 and sets the backup retention period to 14 days. The ApplyImmediately parameter causes the changes to be made immediately, instead of waiting until the next maintenance window.", + "input": { + "DBClusterIdentifier": "cluster-2", + "ApplyImmediately": true, + "BackupRetentionPeriod": 14, + "MasterUserPassword": "newpassword99" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "eu-central-1b", + "eu-central-1c", + "eu-central-1a" + ], + "BackupRetentionPeriod": 14, + "DatabaseName": "", + "DBClusterIdentifier": "cluster-2", + "DBClusterParameterGroup": "default.aurora5.6", + "DBSubnetGroup": "default-vpc-2305ca49", + "Status": "available", + "EarliestRestorableTime": "2020-06-03T02:07:29.637Z", + "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com", + "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora", + "EngineVersion": "5.6.10a", + "LatestRestorableTime": "2020-06-04T15:11:25.748Z", + "Port": 3306, + "MasterUsername": "admin", + "PreferredBackupWindow": "01:55-02:25", + "PreferredMaintenanceWindow": "thu:21:14-thu:21:44", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "cluster-2-instance-1", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-20a5c047", + "Status": "active" + } + ], + "HostedZoneId": "Z1RLNU0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE", + "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-04-03T14:44:02.764Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": true, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] } }, "com.amazonaws.rds#ModifyDBClusterEndpoint": { @@ -15970,7 +18910,37 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nModifies the properties of an endpoint in an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nList of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBClusterMessage": { @@ -16261,7 +19234,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBClusterParameterGroup": { @@ -16281,7 +19255,31 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" + "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", + "smithy.api#examples": [ + { + "title": "To modify parameters in a DB cluster parameter group", + "documentation": "The following example modifies the values of parameters in a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterpg", + "Parameters": [ + { + "ParameterName": "server_audit_logging", + "ParameterValue": "1", + "ApplyMethod": "immediate" + }, + { + "ParameterName": "server_audit_logs_upload", + "ParameterValue": "1", + "ApplyMethod": "immediate" + } + ] + }, + "output": { + "DBClusterParameterGroupName": "mydbclusterpg" + } + } + ] } }, "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { @@ -16303,7 +19301,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBClusterResult": { @@ -16337,7 +19336,33 @@ } ], "traits": { - "smithy.api#documentation": "Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
\nTo share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
\nTo share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.
Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.
Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.
Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n
\nAmazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n
\nAmazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.
", + "smithy.api#examples": [ + { + "title": "To modify a DB snapshot", + "documentation": "The following example upgrades a PostgeSQL 10.6 snapshot named db5-snapshot-upg-test to PostgreSQL 11.7. The new DB engine version is shown after the snapshot has finished upgrading and its status is available.", + "input": { + "DBSnapshotIdentifier": "db5-snapshot-upg-test", + "EngineVersion": "11.7" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "db5-snapshot-upg-test", + "DBInstanceIdentifier": "database-5", + "SnapshotCreateTime": "2020-03-27T20:49:17.092Z", + "Engine": "postgres", + "AllocatedStorage": 20, + "Status": "upgrading", + "Port": 5432, + "AvailabilityZone": "us-west-2a", + "VpcId": "vpc-2ff27557", + "InstanceCreateTime": "2020-03-27T19:59:04.735Z", + "MasterUsername": "postgres", + "EngineVersion": "10.6", + "LicenseModel": "postgresql-license", + "SnapshotType": "manual", + "OptionGroupName": "default:postgres-11", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-upg-test", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-GJMF75LM42IL6BTFRE4UZJ5YM4" + } + } + } + ] } }, "com.amazonaws.rds#ModifyDBSnapshotAttribute": { @@ -17140,7 +20268,35 @@ } ], "traits": { - "smithy.api#documentation": "Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
\nTo share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
\nTo share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.
The option group to identify with the upgraded DB snapshot.
\nYou can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBSnapshotResult": { @@ -17249,7 +20409,62 @@ } ], "traits": { - "smithy.api#documentation": "Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
" + "smithy.api#documentation": "Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
", + "smithy.api#examples": [ + { + "title": "To modify a DB subnet group", + "documentation": "The following example adds a subnet with the ID subnet-08e41f9e230222222 to the DB subnet group named mysubnetgroup. To keep the existing subnets in the subnet group, include their IDs as values in the --subnet-ids option. Make sure to have subnets with at least two different Availability Zones in the DB subnet group.", + "input": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "", + "SubnetIds": [ + "subnet-0a1dc4e1a6f123456", + "subnet-070dd7ecb3aaaaaaa", + "subnet-00f5b198bc0abcdef", + "subnet-08e41f9e230222222" + ] + }, + "output": { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-08e41f9e230222222", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:mysubnetgroup" + } + } + } + ] } }, "com.amazonaws.rds#ModifyDBSubnetGroupMessage": { @@ -17277,7 +20492,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBSubnetGroupResult": { @@ -17320,7 +20536,33 @@ } ], "traits": { - "smithy.api#documentation": "Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.
Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.
Modifies a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.
\nThis operation only applies to Aurora global database clusters.
\nModifies a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.
\nThis operation only applies to Aurora global database clusters.
\nSpecifies whether to allow major version upgrades.
\nConstraints: Must be enabled if you specify a value for the\n EngineVersion parameter that's a different major version than the global\n cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyGlobalClusterResult": { @@ -17462,7 +20731,28 @@ } ], "traits": { - "smithy.api#documentation": "Modifies an existing option group.
" + "smithy.api#documentation": "Modifies an existing option group.
", + "smithy.api#examples": [ + { + "title": "To modify an option group", + "documentation": "The following example adds an option to an option group.", + "input": { + "OptionGroupName": "myawsuser-og02", + "OptionsToInclude": [ + { + "OptionName": "MEMCACHED", + "DBSecurityGroupMemberships": [ + "default" + ] + } + ], + "ApplyImmediately": true + }, + "output": { + "OptionGroup": {} + } + } + ] } }, "com.amazonaws.rds#ModifyOptionGroupMessage": { @@ -17496,7 +20786,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyOptionGroupResult": { @@ -18000,7 +21291,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#output": {} } }, "com.amazonaws.rds#OptionGroupQuotaExceededFault": { @@ -18441,7 +21733,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
Data returned from the DescribePendingMaintenanceActions action.
" + "smithy.api#documentation": "Data returned from the DescribePendingMaintenanceActions action.
", + "smithy.api#output": {} } }, "com.amazonaws.rds#PendingModifiedValues": { @@ -18832,7 +22126,24 @@ } ], "traits": { - "smithy.api#documentation": "Promotes a read replica DB instance to a standalone DB instance.
\nBackup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
\nPromotes a read replica DB instance to a standalone DB instance.
\nBackup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
\nPurchases a reserved DB instance offering.
" + "smithy.api#documentation": "Purchases a reserved DB instance offering.
", + "smithy.api#examples": [ + { + "title": "To purchase a reserved DB instance", + "documentation": "The following example shows how to buy the reserved DB instance offering from the previous example.", + "input": { + "ReservedDBInstancesOfferingId": "", + "ReservedDBInstanceId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4" + }, + "output": { + "ReservedDBInstance": { + "ReservedDBInstanceId": "ri-2020-06-29-16-54-57-670", + "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4", + "DBInstanceClass": "db.t2.micro", + "StartTime": "2020-06-29T16:54:57.670Z", + "Duration": 31536000, + "FixedPrice": 51, + "UsagePrice": 0, + "CurrencyCode": "USD", + "DBInstanceCount": 1, + "ProductDescription": "mysql", + "OfferingType": "Partial Upfront", + "MultiAZ": false, + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.006, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670" + } + } + } + ] } }, "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage": { @@ -18986,7 +22333,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult": { @@ -19103,6 +22451,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RebootDBClusterResult": { @@ -19133,7 +22484,30 @@ } ], "traits": { - "smithy.api#documentation": "You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.
\nRebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
\nFor more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom.
\nIf your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.
\nRebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
\nFor more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom.
\nIf your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.
\nThis action only applies to Aurora DB clusters.
\nDetaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.
\nThis action only applies to Aurora DB clusters.
\nThe Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RemoveFromGlobalClusterResult": { @@ -19357,7 +22772,17 @@ } ], "traits": { - "smithy.api#documentation": "Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" + "smithy.api#documentation": "Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", + "smithy.api#examples": [ + { + "title": "To disassociate an Identity and Access Management (IAM) role from a DB cluster", + "documentation": "The following example removes a role from a DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" + } + } + ] } }, "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { @@ -19383,6 +22808,9 @@ "smithy.api#documentation": "The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RemoveRoleFromDBInstance": { @@ -19432,6 +22860,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription": { @@ -19451,7 +22882,36 @@ } ], "traits": { - "smithy.api#documentation": "Removes a source identifier from an existing RDS event notification subscription.
" + "smithy.api#documentation": "Removes a source identifier from an existing RDS event notification subscription.
", + "smithy.api#examples": [ + { + "title": "To remove a source identifier from a subscription", + "documentation": "The following example removes the specified source identifier from an existing subscription.", + "input": { + "SubscriptionName": "my-instance-events", + "SourceIdentifier": "test-instance-repl" + }, + "output": { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "modifying", + "CustSubscriptionId": "my-instance-events", + "CustomerAwsId": "123456789012", + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "Enabled": false + } + } + } + ] } }, "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage": { @@ -19473,7 +22933,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult": { @@ -19516,7 +22977,20 @@ } ], "traits": { - "smithy.api#documentation": "Removes metadata tags from an Amazon RDS resource.
\nFor an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Removes metadata tags from an Amazon RDS resource.
\nFor an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n
", + "smithy.api#examples": [ + { + "title": "To remove tags from a resource", + "documentation": "The following example removes tags from a resource.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:mydbinstance", + "TagKeys": [ + "Name", + "Environment" + ] + } + } + ] } }, "com.amazonaws.rds#RemoveTagsFromResourceMessage": { @@ -19538,7 +23012,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#ReplicaMode": { @@ -19710,7 +23185,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the result of a successful invocation of the DescribeReservedDBInstances action.
Contains the result of a successful invocation of the DescribeReservedDBInstances action.
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" + "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", + "smithy.api#examples": [ + { + "title": "To reset all parameters to their default values", + "documentation": "The following example resets all parameter values in a customer-created DB cluster parameter group to their default values.", + "input": { + "DBClusterParameterGroupName": "mydbclpg", + "ResetAllParameters": true + }, + "output": { + "DBClusterParameterGroupName": "mydbclpg" + } + } + ] } }, "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { @@ -19910,7 +23400,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#ResetDBParameterGroup": { @@ -19930,7 +23421,20 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.
Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters. The source DB engine must be MySQL.
\nCreates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters. The source DB engine must be MySQL.
\nSpecifies the storage type to be associated with the DB cluster.
\nValid values: aurora, aurora-iopt1\n
Default: aurora\n
Valid for: Aurora DB clusters only
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBClusterFromS3Result": { @@ -20355,7 +23925,66 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
\nThe target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" + "smithy.api#documentation": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
\nThe target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", + "smithy.api#examples": [ + { + "title": "To restore a DB cluster from a snapshot", + "documentation": "The following example restores an Aurora PostgreSQL DB cluster compatible with PostgreSQL version 10.7 from a DB cluster snapshot named test-instance-snapshot.", + "input": { + "DBClusterIdentifier": "newdbcluster", + "SnapshotIdentifier": "test-instance-snapshot", + "Engine": "aurora-postgresql", + "EngineVersion": "10.7" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "newdbcluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-06-05T15:06:58.634Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { @@ -20531,7 +24160,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult": { @@ -20557,6 +24187,9 @@ { "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" }, + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + }, { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, @@ -20610,7 +24243,66 @@ } ], "traits": { - "smithy.api#documentation": "Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.
For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" + "smithy.api#documentation": "Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.
For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", + "smithy.api#examples": [ + { + "title": "To restore a DB cluster to a specified time", + "documentation": "The following example restores the DB cluster named database-4 to the latest possible time. Using copy-on-write as the restore type restores the new DB cluster as a clone of the source DB cluster.", + "input": { + "DBClusterIdentifier": "sample-cluster-clone", + "RestoreType": "copy-on-write", + "SourceDBClusterIdentifier": "database-4", + "UseLatestRestorableTime": true + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "sample-cluster-clone", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd", + "ClusterCreateTime": "2020-03-10T19:57:38.967Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false + } + } + } + ] } }, "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { @@ -20632,8 +24324,7 @@ "SourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the source DB cluster from which to restore.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the source DB cluster from which to restore.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "RestoreToTime": { @@ -20774,10 +24465,17 @@ "traits": { "smithy.api#documentation": "The network type of the DB cluster.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" } + }, + "SourceDbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The resource ID of the source DB cluster from which to restore.
" + } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult": { @@ -20868,7 +24566,38 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
\nIf you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.
\nIf you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
\nIf you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.
\nIf you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.
\nThis setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nIf you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Result": { @@ -21581,7 +25314,97 @@ } ], "traits": { - "smithy.api#documentation": "Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
\nThe target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.
\nThis command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
\nThe target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.
\nThis command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).
\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.
\nRevokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).
\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.
\nContains the result of a successful invocation of the DescribeSourceRegions action.
Contains the result of a successful invocation of the DescribeSourceRegions action.
Starts a database activity stream to monitor activity on the database.\n For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide or\n \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Starts a database activity stream to monitor activity on the database.\n For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide or\n \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.
", + "smithy.api#examples": [ + { + "title": "To start a database activity stream", + "documentation": "The following example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster.", + "input": { + "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", + "Mode": "async", + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "ApplyImmediately": true + }, + "output": { + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", + "Status": "starting", + "Mode": "async", + "ApplyImmediately": true + } + } + ] } }, "com.amazonaws.rds#StartActivityStreamRequest": { @@ -22485,7 +26343,29 @@ } ], "traits": { - "smithy.api#documentation": "Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.
\nFor more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nStarts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.
\nFor more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nStarts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.
\nFor more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.
\nFor more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.
Enables replication of automated backups to a different Amazon Web Services Region.
\nThis command doesn't apply to RDS Custom.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Enables replication of automated backups to a different Amazon Web Services Region.
\nThis command doesn't apply to RDS Custom.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
", + "smithy.api#examples": [ + { + "title": "To enable cross-Region automated backups", + "documentation": "The following example replicates automated backups from a DB instance in the US East (N. Virginia) Region. The backup retention period is 14 days.", + "input": { + "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "BackupRetentionPeriod": 14 + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": {}, + "AllocatedStorage": 20, + "Status": "pending", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 14, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { @@ -22615,6 +26545,9 @@ "smithy.api#documentation": "In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.
\nTo learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.
Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nYou can't export snapshot data from RDS Custom DB instances.
\nYou can't export cluster data from Multi-AZ DB clusters.
\nFor more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
\nFor more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nYou can't export snapshot data from RDS Custom DB instances.
\nYou can't export cluster data from Multi-AZ DB clusters.
\nFor more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
\nFor more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.
", + "smithy.api#examples": [ + { + "title": "To export a snapshot to Amazon S3", + "documentation": "The following example exports a DB snapshot named db5-snapshot-test to the Amazon S3 bucket named mybucket.", + "input": { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "S3BucketName": "mybucket", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff" + }, + "output": { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "SnapshotTime": "2020-03-27T20:48:42.023Z", + "S3Bucket": "mybucket", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "STARTING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + } + ] } }, "com.amazonaws.rds#StartExportTaskMessage": { @@ -22745,6 +26705,9 @@ "smithy.api#documentation": "The data to be exported from the snapshot or cluster. \n If this parameter is not provided, all of the data is exported.\n Valid values are the following:
\n\n database - Export all the data from a specified database.
\n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.
For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.
For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.
", + "smithy.api#examples": [ + { + "title": "To stop a database activity stream", + "documentation": "The following example stops an activity stream in an Aurora cluster named my-pg-cluster.", + "input": { + "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", + "ApplyImmediately": true + }, + "output": { + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", + "Status": "stopping" + } + } + ] } }, "com.amazonaws.rds#StopActivityStreamRequest": { @@ -22843,7 +26821,29 @@ } ], "traits": { - "smithy.api#documentation": "Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.
\nFor more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nStops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.
\nFor more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nStops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.
\nFor more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.
\nFor more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.
Stops automated backup replication for a DB instance.
\nThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Stops automated backup replication for a DB instance.
\nThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
", + "smithy.api#examples": [ + { + "title": "To stop replicating automated backups", + "documentation": "The following example ends replication of automated backups. Replicated backups are retained according to the set backup retention period.", + "input": { + "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db" + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": { + "EarliestTime": "2020-12-04T23:13:21.030Z", + "LatestTime": "2020-12-07T19:59:57Z" + }, + "AllocatedStorage": 20, + "Status": "replicating", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 7, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { @@ -22928,6 +26980,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult": { @@ -22957,6 +27012,9 @@ "smithy.api#documentation": "The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StopDBInstanceResult": { @@ -23290,6 +27348,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#SwitchoverReadReplicaResult": { @@ -23357,7 +27418,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#output": {} } }, "com.amazonaws.rds#TargetDBClusterParameterGroupName": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 24c63f56607..079b1879603 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -3867,7 +3867,7 @@ "EndTimeOffset": { "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", "traits": { - "smithy.api#documentation": "If specified, monitoring jobs substract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + "smithy.api#documentation": "If specified, monitoring jobs subtract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" } } }, @@ -15926,7 +15926,7 @@ "EndpointStatus": { "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
\n UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint\n is in service with a mix of the old and new endpoint configurations. For information about how to remedy\n this issue and restore the endpoint's status to InService, see\n Rolling Deployments.
The model latency percentile threshold.
" + "smithy.api#documentation": "The model latency percentile threshold. For custom load tests, specify the value as P95.
Specifies how many concurrent users to start with.
" + "smithy.api#documentation": "Specifies how many concurrent users to start with. The value should be between 1 and 3.
" } }, "SpawnRate": { @@ -42639,7 +42664,7 @@ "DurationInSeconds": { "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", "traits": { - "smithy.api#documentation": "Specifies how long traffic phase should be.
" + "smithy.api#documentation": "Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600.\n This value should not exceed JobDurationInSeconds.
Specifies the maximum duration of the job, in seconds.>
" + "smithy.api#documentation": "Specifies the maximum duration of the job, in seconds. The maximum value is 7200.
" } }, "TrafficPattern": { @@ -47074,6 +47099,12 @@ "traits": { "smithy.api#documentation": "The interval of time taken by a model to respond as viewed from SageMaker. \n The interval includes the local communication time taken to send the request \n and to fetch the response from the container of a model and the time taken to \n complete the inference in the container.
" } + }, + "FlatInvocations": { + "target": "com.amazonaws.sagemaker#FlatInvocations", + "traits": { + "smithy.api#documentation": "Stops a load test when the number of invocations (TPS) peaks and flattens,\n which means that the instance has reached capacity. The default value is Stop.\n If you want the load test to continue after invocations have flattened, set the value to Continue.
Defines how long each traffic step should be.
" + } + }, + "NumberOfSteps": { + "target": "com.amazonaws.sagemaker#NumberOfSteps", + "traits": { + "smithy.api#documentation": "Specifies how many steps to perform during traffic.
" + } + }, + "UsersPerStep": { + "target": "com.amazonaws.sagemaker#UsersPerStep", + "traits": { + "smithy.api#documentation": "Specifies how many new users to spawn in each step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the stairs traffic pattern for an Inference Recommender load test. This pattern\n type consists of multiple steps where the number of users increases at each step.
\nSpecify either the stairs or phases traffic pattern.
" + } + }, "com.amazonaws.sagemaker#StartEdgeDeploymentStage": { "type": "operation", "input": { @@ -54044,7 +54065,7 @@ "TrafficType": { "target": "com.amazonaws.sagemaker#TrafficType", "traits": { - "smithy.api#documentation": "Defines the traffic patterns.
" + "smithy.api#documentation": "Defines the traffic patterns. Choose either PHASES or STAIRS.
Defines the phases traffic specification.
" } + }, + "Stairs": { + "target": "com.amazonaws.sagemaker#Stairs", + "traits": { + "smithy.api#documentation": "Defines the stairs traffic pattern.
" + } } }, "traits": { @@ -54123,6 +54150,12 @@ "traits": { "smithy.api#enumValue": "PHASES" } + }, + "STAIRS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STAIRS" + } } } }, @@ -59258,6 +59291,15 @@ "smithy.api#documentation": "A collection of settings that apply to users of Amazon SageMaker Studio. These settings are\n specified when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.
\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.