A key value pair of attributes of a customer profile.
" } + }, + "PartyTypeString": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "An alternative to PartyType which accepts any string as input.
An alternative to Gender which accepts any string as input.
Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly\n selects a sample of matching groups from the existing matching results, and applies the\n automerging settings that you provided. You can then view the number of profiles in the\n sample, the number of matches, and the number of profiles identified to be merged. This\n enables you to evaluate the accuracy of the attributes in your matching list.
\nYou can't view which profiles are matched and would be merged.
\nWe strongly recommend you use this API to do a dry run of the automerging process\n before running the Identity Resolution Job. Include at least two matching\n attributes. If your matching list includes too few attributes (such as only\n FirstName or only LastName), there may be a large number of\n matches. This increases the chances of erroneous merges.
Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly\n selects a sample of matching groups from the existing matching results, and applies the\n automerging settings that you provided. You can then view the number of profiles in the\n sample, the number of matches, and the number of profiles identified to be merged. This\n enables you to evaluate the accuracy of the attributes in your matching list.
\nYou can't view which profiles are matched and would be merged.
\nWe strongly recommend you use this API to do a dry run of the automerging process\n before running the Identity Resolution Job. Include at least two matching\n attributes. If your matching list includes too few attributes (such as only\n FirstName or only LastName), there may be a large number of\n matches. This increases the chances of erroneous merges.
Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.
\nThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
Amazon Connect uses the following profile attributes to identify matches:
\nPhoneNumber
\nHomePhoneNumber
\nBusinessPhoneNumber
\nMobilePhoneNumber
\nEmailAddress
\nPersonalEmailAddress
\nBusinessEmailAddress
\nFullName
\nFor example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
", + "smithy.api#documentation": "Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.
\nThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
Amazon Connect uses the following profile attributes to identify matches:
\nPhoneNumber
\nHomePhoneNumber
\nBusinessPhoneNumber
\nMobilePhoneNumber
\nEmailAddress
\nPersonalEmailAddress
\nBusinessEmailAddress
\nFullName
\nFor example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
", "smithy.api#http": { "method": "GET", "uri": "/domains/{DomainName}/matches", @@ -5381,7 +5384,7 @@ } ], "traits": { - "smithy.api#documentation": "Runs an AWS Lambda job that does the following:
\nAll the profileKeys in the ProfileToBeMerged will be moved to the\n main profile.
All the objects in the ProfileToBeMerged will be moved to the main\n profile.
All the ProfileToBeMerged will be deleted at the end.
All the profileKeys in the ProfileIdsToBeMerged will be moved to the\n main profile.
Standard fields are merged as follows:
\nFields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.
\nWhen there are conflicting fields:
\n\nIf no SourceProfileIds entry is specified, the main\n Profile value is always taken.
If a SourceProfileIds entry is specified, the specified\n profileId is always taken, even if it is a NULL value.
You can use MergeProfiles together with GetMatches, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).
", + "smithy.api#documentation": "Runs an AWS Lambda job that does the following:
\nAll the profileKeys in the ProfileToBeMerged will be moved to the\n main profile.
All the objects in the ProfileToBeMerged will be moved to the main\n profile.
All the ProfileToBeMerged will be deleted at the end.
All the profileKeys in the ProfileIdsToBeMerged will be moved to the\n main profile.
Standard fields are merged as follows:
\nFields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.
\nWhen there are conflicting fields:
\nIf no SourceProfileIds entry is specified, the main\n Profile value is always taken.
If a SourceProfileIds entry is specified, the specified\n profileId is always taken, even if it is a NULL value.
You can use MergeProfiles together with GetMatches, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).
", "smithy.api#http": { "method": "POST", "uri": "/domains/{DomainName}/profiles/objects/merge", @@ -7881,6 +7884,18 @@ "traits": { "smithy.api#documentation": "A key value pair of attributes of a customer profile.
" } + }, + "PartyTypeString": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "An alternative to PartyType which accepts any string as input.
An alternative to Gender which accepts any string as input.
Accept a VPC peering connection request. To accept a request, the VPC peering connection must\n be in the pending-acceptance state, and you must be the owner of the peer VPC.\n Use DescribeVpcPeeringConnections to view your outstanding VPC\n peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering\n connection in the Region of the accepter VPC.
" + "smithy.api#documentation": "Accept a VPC peering connection request. To accept a request, the VPC peering connection must\n be in the pending-acceptance state, and you must be the owner of the peer VPC.\n Use DescribeVpcPeeringConnections to view your outstanding VPC\n peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering\n connection in the Region of the accepter VPC.
" } }, "com.amazonaws.ec2#AcceptVpcPeeringConnectionRequest": { @@ -975,7 +975,7 @@ "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A description for the entry.
\nConstraints: Up to 255 characters in length.
" + "smithy.api#documentation": "A description for the entry.
\nConstraints: Up to 255 characters in length.
" } } }, @@ -1378,7 +1378,7 @@ "target": "com.amazonaws.ec2#AdvertiseByoipCidrResult" }, "traits": { - "smithy.api#documentation": "Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).
\nYou can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.
\nWe recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.
\nIt can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.
\nTo stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
" + "smithy.api#documentation": "Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).
\nYou can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.
\nWe recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.
\nIt can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.
\nTo stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
" } }, "com.amazonaws.ec2#AdvertiseByoipCidrRequest": { @@ -1468,7 +1468,7 @@ "NetworkBorderGroup": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.
\nUse DescribeAvailabilityZones to view the network border groups.
\n \nYou cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, \n you receive an InvalidParameterCombination error.
A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.
\nUse DescribeAvailabilityZones to view the network border groups.
\nYou cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, \n you receive an InvalidParameterCombination error.
Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.
\n\nDefault: on\n
Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.
\nDefault: on\n
Specifies the instance type to be supported by the Dedicated Hosts. If you specify an\n instance type, the Dedicated Hosts support instances of the specified instance type\n only.
\n\nIf you want the Dedicated Hosts to support multiple instance types in a specific\n instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.
", + "smithy.api#documentation": "Specifies the instance type to be supported by the Dedicated Hosts. If you specify an\n instance type, the Dedicated Hosts support instances of the specified instance type\n only.
\nIf you want the Dedicated Hosts to support multiple instance types in a specific\n instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.
", "smithy.api#xmlName": "instanceType" } }, "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Specifies the instance family to be supported by the Dedicated Hosts. If you specify\n an instance family, the Dedicated Hosts support multiple instance types within that\n instance family.
\n\nIf you want the Dedicated Hosts to support a specific instance type only, omit this\n parameter and specify InstanceType instead. You cannot\n specify InstanceFamily and InstanceType in the same request.
" + "smithy.api#documentation": "Specifies the instance family to be supported by the Dedicated Hosts. If you specify\n an instance family, the Dedicated Hosts support multiple instance types within that\n instance family.
\nIf you want the Dedicated Hosts to support a specific instance type only, omit this\n parameter and specify InstanceType instead. You cannot\n specify InstanceFamily and InstanceType in the same request.
" } }, "Quantity": { @@ -1641,7 +1641,7 @@ "HostRecovery": { "target": "com.amazonaws.ec2#HostRecovery", "traits": { - "smithy.api#documentation": "Indicates whether to enable or disable host recovery for the Dedicated Host. Host\n recovery is disabled by default. For more information, see Host recovery\n in the Amazon EC2 User Guide.
\nDefault: off\n
Indicates whether to enable or disable host recovery for the Dedicated Host. Host\n recovery is disabled by default. For more information, see Host recovery\n in the Amazon EC2 User Guide.
\nDefault: off\n
Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type\n in the Amazon Elastic Compute Cloud User Guide.
\nYou must specify either the IPv6 addresses or the IPv6 address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type\n in the Amazon Elastic Compute Cloud User Guide.
\nYou must specify either the IPv6 addresses or the IPv6 address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#AssignIpv6AddressesRequest": { @@ -6662,7 +6653,7 @@ "target": "com.amazonaws.ec2#AssignPrivateIpAddressesResult" }, "traits": { - "smithy.api#documentation": "Assigns one or more secondary private IP addresses to the specified network interface.
\nYou can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about \n Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nWhen you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.
\nRemapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Assigns one or more secondary private IP addresses to the specified network interface.
\nYou can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about \n Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nWhen you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.
\nRemapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#AssignPrivateIpAddressesRequest": { @@ -6692,7 +6683,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressStringList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
\nIf you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
", + "smithy.api#documentation": "The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
\nIf you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
", "smithy.api#xmlName": "privateIpAddress" } }, @@ -6789,7 +6780,7 @@ "target": "com.amazonaws.ec2#AssociateAddressResult" }, "traits": { - "smithy.api#documentation": "Associates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.
\n[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic\n IP address is associated with the primary IP address. If the Elastic IP address is already\n associated with a different instance or a network interface, you get an error unless you allow\n reassociation. You cannot associate an Elastic IP address with an instance or network\n interface that has an existing Elastic IP address.
\n[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.
\nYou cannot associate an Elastic IP address with an interface in a different network border group.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nAssociates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.
\n[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic\n IP address is associated with the primary IP address. If the Elastic IP address is already\n associated with a different instance or a network interface, you get an error unless you allow\n reassociation. You cannot associate an Elastic IP address with an instance or network\n interface that has an existing Elastic IP address.
\n[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.
\nYou cannot associate an Elastic IP address with an interface in a different network border group.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
\n \tFor EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
", + "smithy.api#documentation": "[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
\nFor EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
", "smithy.api#xmlName": "networkInterfaceId" } }, @@ -6873,7 +6864,7 @@ "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetworkResult" }, "traits": { - "smithy.api#documentation": "Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
\n\tIf you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.
" + "smithy.api#documentation": "Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
\nIf you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.
" } }, "com.amazonaws.ec2#AssociateClientVpnTargetNetworkRequest": { @@ -6985,7 +6976,7 @@ "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleResult" }, "traits": { - "smithy.api#documentation": "Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. \n\t\t\tThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more \n\t\t\tinformation, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves \n\t\t\t\t\tUser Guide.
\n\t\t\n\t\tWhen the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted \n\t\t\tprivate key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate \n\t\t\tis encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
\n\t\t\n\t\tTo enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject \n\t\t\ton the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\n\t\t\tyou must grant it permission to call kms:Decrypt on the KMS key returned by the command. \n\t\t\tFor more information, see \n\t\t\t\tGrant the role permission to access the certificate and encryption key in the \n\t\t\tAmazon Web Services Nitro Enclaves User Guide.
Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. \n\t\t\tThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more \n\t\t\tinformation, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves \n\t\t\t\t\tUser Guide.
\nWhen the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted \n\t\t\tprivate key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate \n\t\t\tis encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
\nTo enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject \n\t\t\ton the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\n\t\t\tyou must grant it permission to call kms:Decrypt on the KMS key returned by the command. \n\t\t\tFor more information, see \n\t\t\t\tGrant the role permission to access the certificate and encryption key in the \n\t\t\tAmazon Web Services Nitro Enclaves User Guide.
Associates a subnet in your VPC or an internet gateway or virtual private gateway\n attached to your VPC with a route table in your VPC. This association causes traffic\n from the subnet or gateway to be routed according to the routes in the route table. The\n action returns an association ID, which you need in order to disassociate the route\n table later. A route table can be associated with multiple subnets.
\nFor more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Associates a subnet in your VPC or an internet gateway or virtual private gateway\n attached to your VPC with a route table in your VPC. This association causes traffic\n from the subnet or gateway to be routed according to the routes in the route table. The\n action returns an association ID, which you need in order to disassociate the route\n table later. A route table can be associated with multiple subnets.
\nFor more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#AssociateRouteTableRequest": { @@ -7281,7 +7272,7 @@ "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainResult" }, "traits": { - "smithy.api#documentation": "Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
\nThe transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments \n to see the state of the attachment.
" + "smithy.api#documentation": "Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
\nThe transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments \n to see the state of the attachment.
" } }, "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest": { @@ -7445,7 +7436,7 @@ "target": "com.amazonaws.ec2#AssociateTrunkInterfaceResult" }, "traits": { - "smithy.api#documentation": "This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.
\nAssociates a branch network interface with a trunk network interface.
\nBefore you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.
\nAssociates a branch network interface with a trunk network interface.
\nBefore you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed\n at /56.
\nYou must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.
\nFor more information about associating CIDR blocks with your VPC and applicable\n restrictions, see VPC and subnet sizing in the\n Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed\n at /56.
\nYou must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.
\nFor more information about associating CIDR blocks with your VPC and applicable\n restrictions, see VPC and subnet sizing in the\n Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#AssociateVpcCidrBlockRequest": { @@ -7577,7 +7568,7 @@ "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
" + "smithy.api#documentation": "An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
" } }, "Ipv4IpamPoolId": { @@ -7856,7 +7847,7 @@ "target": "com.amazonaws.ec2#AttachClassicLinkVpcResult" }, "traits": { - "smithy.api#documentation": "We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n\tLinks an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's\n\t\t\tsecurity groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You\n\t\t\tcan only link an instance that's in the running state. An instance is\n\t\t\tautomatically unlinked from a VPC when it's stopped - you can link it to the VPC again when\n\t\t\tyou restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
\n\t\tLinking your instance to a VPC is sometimes referred to as attaching your instance.
" + "smithy.api#documentation": "We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nLinks an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's\n\t\t\tsecurity groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You\n\t\t\tcan only link an instance that's in the running state. An instance is\n\t\t\tautomatically unlinked from a VPC when it's stopped - you can link it to the VPC again when\n\t\t\tyou restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
\nLinking your instance to a VPC is sometimes referred to as attaching your instance.
" } }, "com.amazonaws.ec2#AttachClassicLinkVpcRequest": { @@ -8195,7 +8186,7 @@ "target": "com.amazonaws.ec2#AttachVpnGatewayResult" }, "traits": { - "smithy.api#documentation": "Attaches a virtual private gateway to a VPC. You can attach one virtual private\n gateway to one VPC at a time.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" + "smithy.api#documentation": "Attaches a virtual private gateway to a VPC. You can attach one virtual private\n gateway to one VPC at a time.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" } }, "com.amazonaws.ec2#AttachVpnGatewayRequest": { @@ -8512,7 +8503,7 @@ "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgressResult" }, "traits": { - "smithy.api#documentation": "[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
\nAn outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR\n address ranges, or to the instances that are associated with the specified source\n security groups. When specifying an outbound rule for your security group in a VPC, the\n IpPermissions must include a destination for the traffic.
You specify a protocol for each rule (for example, TCP). \n For the TCP and UDP protocols, you must also specify the destination port or port range. \n For the ICMP protocol, you must also specify the ICMP type and code. \n You can use -1 for the type or code to mean all types or all codes.
\nRule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
\nFor information about VPC security group quotas, see Amazon VPC quotas.
" + "smithy.api#documentation": "[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
\nAn outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR\n address ranges, or to the instances that are associated with the specified source\n security groups. When specifying an outbound rule for your security group in a VPC, the\n IpPermissions must include a destination for the traffic.
You specify a protocol for each rule (for example, TCP). \n For the TCP and UDP protocols, you must also specify the destination port or port range. \n For the ICMP protocol, you must also specify the ICMP type and code. \n You can use -1 for the type or code to mean all types or all codes.
\nRule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
\nFor information about VPC security group quotas, see Amazon VPC quotas.
" } }, "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest": { @@ -8639,7 +8630,7 @@ "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngressResult" }, "traits": { - "smithy.api#documentation": "Adds the specified inbound (ingress) rules to a security group.
\nAn inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.
You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.
\nRule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.
\nFor more information about VPC security group quotas, see Amazon VPC quotas.
\n \nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nAdds the specified inbound (ingress) rules to a security group.
\nAn inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.
You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.
\nRule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.
\nFor more information about VPC security group quotas, see Amazon VPC quotas.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nThe IP protocol name (tcp, udp, icmp) or number\n (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.
[VPC only] Use -1 to specify all protocols. If you specify -1 or a \n protocol other than tcp, udp, or icmp, traffic on all ports \n is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
" + "smithy.api#documentation": "The IP protocol name (tcp, udp, icmp) or number\n (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.
[VPC only] Use -1 to specify all protocols. If you specify -1 or a \n protocol other than tcp, udp, or icmp, traffic on all ports \n is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
" } }, "SourceSecurityGroupName": { @@ -9215,7 +9206,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "VirtualName", - "smithy.api#documentation": "The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.
\nConstraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.
", + "smithy.api#documentation": "The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.
\nConstraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.
", "smithy.api#xmlName": "virtualName" } }, @@ -9331,7 +9322,7 @@ "target": "com.amazonaws.ec2#BundleInstanceResult" }, "traits": { - "smithy.api#documentation": "Bundles an Amazon instance store-backed Windows instance.
\nDuring bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.
\nThis action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
\n\t\t\tBundles an Amazon instance store-backed Windows instance.
\nDuring bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.
\nThis action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
\nCancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to\n\t\t\tcancelled.
Instances running in the reserved capacity continue running until you stop them. Stopped\n\t\t\tinstances that target the Capacity Reservation can no longer launch. Modify these instances to either\n\t\t\ttarget a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation\n\t\t\tthat has matching attributes and sufficient capacity.
" + "smithy.api#documentation": "Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to\n\t\t\tcancelled.
Instances running in the reserved capacity continue running until you stop them. Stopped\n\t\t\tinstances that target the Capacity Reservation can no longer launch. Modify these instances to either\n\t\t\ttarget a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation\n\t\t\tthat has matching attributes and sufficient capacity.
" } }, "com.amazonaws.ec2#CancelCapacityReservationFleetError": { @@ -9798,7 +9789,7 @@ "target": "com.amazonaws.ec2#CancelCapacityReservationFleetsResult" }, "traits": { - "smithy.api#documentation": "Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation \n\t\t\tFleet, the following happens:
\n\t\tThe Capacity Reservation Fleet's status changes to cancelled.
The individual Capacity Reservations in the Fleet are cancelled. Instances running \n\t\t\t\t\tin the Capacity Reservations at the time of cancelling the Fleet continue to run in \n\t\t\t\t\tshared capacity.
\n\t\t\tThe Fleet stops creating new Capacity Reservations.
\n\t\t\tCancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation \n\t\t\tFleet, the following happens:
\nThe Capacity Reservation Fleet's status changes to cancelled.
The individual Capacity Reservations in the Fleet are cancelled. Instances running \n\t\t\t\t\tin the Capacity Reservations at the time of cancelling the Fleet continue to run in \n\t\t\t\t\tshared capacity.
\nThe Fleet stops creating new Capacity Reservations.
\nCancels the specified Spot Fleet requests.
\nAfter you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances.\n You must specify whether the Spot Fleet should also terminate its Spot Instances. If you\n terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.
Cancels the specified Spot Fleet requests.
\nAfter you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances.\n You must specify whether the Spot Fleet should also terminate its Spot Instances. If you\n terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.
Cancels one or more Spot Instance requests.
\nCanceling a Spot Instance request does not terminate running Spot Instances\n associated with the request.
\nCancels one or more Spot Instance requests.
\nCanceling a Spot Instance request does not terminate running Spot Instances\n associated with the request.
\nIndicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
\n\t\t\n default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
\n\n default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
\n\t\t\t\n active - The Capacity Reservation is active and the capacity is available for your use.
\n expired - The Capacity Reservation expired automatically at the date and time specified \n\t\t\t\t\tin your request. The reserved capacity is no longer available for your use.
\n cancelled - The Capacity Reservation was cancelled. The reserved capacity is no\n\t\t\t\t\tlonger available for your use.
\n pending - The Capacity Reservation request was successful but the capacity \n\t\t\t\t\tprovisioning is still pending.
\n failed - The Capacity Reservation request has failed. A request might fail \n\t\t\t\t\tdue to invalid request parameters, capacity constraints, or instance limit constraints. \n\t\t\t\t\tFailed requests are retained for 60 minutes.
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
\n\n active - The Capacity Reservation is active and the capacity is available for your use.
\n expired - The Capacity Reservation expired automatically at the date and time specified \n\t\t\t\t\tin your request. The reserved capacity is no longer available for your use.
\n cancelled - The Capacity Reservation was cancelled. The reserved capacity is no\n\t\t\t\t\tlonger available for your use.
\n pending - The Capacity Reservation request was successful but the capacity \n\t\t\t\t\tprovisioning is still pending.
\n failed - The Capacity Reservation request has failed. A request might fail \n\t\t\t\t\tdue to invalid request parameters, capacity constraints, or instance limit constraints. \n\t\t\t\t\tFailed requests are retained for 60 minutes.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:
\n\t\t\n unlimited - The Capacity Reservation remains active until you explicitly cancel it.
\n limited - The Capacity Reservation expires automatically at a specified date and time.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:
\n\n unlimited - The Capacity Reservation remains active until you explicitly cancel it.
\n limited - The Capacity Reservation expires automatically at a specified date and time.
Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:
\n\t\t\n open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, \n\t\t\t\tand Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying \n\t\t\t\tany additional parameters.
\n targeted - The Capacity Reservation only accepts instances that have matching attributes\n\t\t\t\t\t(instance type, platform, and Availability Zone), and explicitly target the\n\t\t\t\t\tCapacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:
\n\n open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, \n\t\t\t\tand Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying \n\t\t\t\tany additional parameters.
\n targeted - The Capacity Reservation only accepts instances that have matching attributes\n\t\t\t\t\t(instance type, platform, and Availability Zone), and explicitly target the\n\t\t\t\t\tCapacity Reservation. This ensures that only permitted instances can use the reserved capacity.
The state of the Capacity Reservation Fleet. Possible states include:
\n\t\t\n submitted - The Capacity Reservation Fleet request has been submitted \n\t\t\t\t\tand Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.
\n modifying - The Capacity Reservation Fleet is being modified. The Fleet \n\t\t\t\t\tremains in this state until the modification is complete.
\n active - The Capacity Reservation Fleet has fulfilled its total target \n\t\t\t\t\tcapacity and it is attempting to maintain this capacity. The Fleet remains in this \n\t\t\t\t\tstate until it is modified or deleted.
\n partially_fulfilled - The Capacity Reservation Fleet has partially \n\t\t\t\t\tfulfilled its total target capacity. There is insufficient Amazon EC2 to \n\t\t\t\t\tfulfill the total target capacity. The Fleet is attempting to asynchronously fulfill \n\t\t\t\t\tits total target capacity.
\n expiring - The Capacity Reservation Fleet has reach its end date and it \n\t\t\t\t\tis in the process of expiring. One or more of its Capacity reservations might still \n\t\t\t\t\tbe active.
\n expired - The Capacity Reservation Fleet has reach its end date. The Fleet \n\t\t\t\t\tand its Capacity Reservations are expired. The Fleet can't create new Capacity \n\t\t\t\t\tReservations.
\n cancelling - The Capacity Reservation Fleet is in the process of being \n\t\t\t\t\tcancelled. One or more of its Capacity reservations might still be active.
\n cancelled - The Capacity Reservation Fleet has been manually cancelled. \n\t\t\t\t\tThe Fleet and its Capacity Reservations are cancelled and the Fleet can't create new \n\t\t\t\t\tCapacity Reservations.
\n failed - The Capacity Reservation Fleet failed to reserve capacity for \n\t\t\t\t\tthe specified instance types.
The state of the Capacity Reservation Fleet. Possible states include:
\n\n submitted - The Capacity Reservation Fleet request has been submitted \n\t\t\t\t\tand Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.
\n modifying - The Capacity Reservation Fleet is being modified. The Fleet \n\t\t\t\t\tremains in this state until the modification is complete.
\n active - The Capacity Reservation Fleet has fulfilled its total target \n\t\t\t\t\tcapacity and it is attempting to maintain this capacity. The Fleet remains in this \n\t\t\t\t\tstate until it is modified or deleted.
\n partially_fulfilled - The Capacity Reservation Fleet has partially \n\t\t\t\t\tfulfilled its total target capacity. There is insufficient Amazon EC2 to \n\t\t\t\t\tfulfill the total target capacity. The Fleet is attempting to asynchronously fulfill \n\t\t\t\t\tits total target capacity.
\n expiring - The Capacity Reservation Fleet has reach its end date and it \n\t\t\t\t\tis in the process of expiring. One or more of its Capacity reservations might still \n\t\t\t\t\tbe active.
\n expired - The Capacity Reservation Fleet has reach its end date. The Fleet \n\t\t\t\t\tand its Capacity Reservations are expired. The Fleet can't create new Capacity \n\t\t\t\t\tReservations.
\n cancelling - The Capacity Reservation Fleet is in the process of being \n\t\t\t\t\tcancelled. One or more of its Capacity reservations might still be active.
\n cancelled - The Capacity Reservation Fleet has been manually cancelled. \n\t\t\t\t\tThe Fleet and its Capacity Reservations are cancelled and the Fleet can't create new \n\t\t\t\t\tCapacity Reservations.
\n failed - The Capacity Reservation Fleet failed to reserve capacity for \n\t\t\t\t\tthe specified instance types.
The tenancy of the Capacity Reservation Fleet. Tenancies include:
\n\t\t\n default - The Capacity Reservation Fleet is created on hardware that is \n\t\t\t\t\tshared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation Fleet is created on single-tenant \n\t\t\t\t\thardware that is dedicated to a single Amazon Web Services account.
The tenancy of the Capacity Reservation Fleet. Tenancies include:
\n\n default - The Capacity Reservation Fleet is created on hardware that is \n\t\t\t\t\tshared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation Fleet is created on single-tenant \n\t\t\t\t\thardware that is dedicated to a single Amazon Web Services account.
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.
\n\t\tCurrently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.
\nCurrently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
\n\t\t\n open - The instance can run in any open Capacity Reservation that has matching attributes \n\t\t\t\t(instance type, platform, Availability Zone).
\n none - The instance avoids running in a Capacity Reservation even if one is available. The\n\t\t\t\t\tinstance runs as an On-Demand Instance.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
\n\n open - The instance can run in any open Capacity Reservation that has matching attributes \n\t\t\t\t(instance type, platform, Availability Zone).
\n none - The instance avoids running in a Capacity Reservation even if one is available. The\n\t\t\t\t\tinstance runs as an On-Demand Instance.
Describes an instance's Capacity Reservation targeting option. You can specify only one parameter \n\t\t\tat a time. If you specify CapacityReservationPreference and \n\t\t\tCapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance\n\t\t\tto run as an On-Demand Instance or to run in any open Capacity Reservation that has\n\t\t\tmatching attributes (instance type, platform, Availability Zone). Use the\n\t\t\tCapacityReservationTarget parameter to explicitly target a specific\n\t\t\t \tCapacity Reservation or a Capacity Reservation group.
Describes an instance's Capacity Reservation targeting option. You can specify only one parameter \n\t\t\tat a time. If you specify CapacityReservationPreference and \n\t\t\tCapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance\n\t\t\tto run as an On-Demand Instance or to run in any open Capacity Reservation that has\n\t\t\tmatching attributes (instance type, platform, Availability Zone). Use the\n\t\t\tCapacityReservationTarget parameter to explicitly target a specific\n\t\t\t \tCapacity Reservation or a Capacity Reservation group.
Describes the instance's Capacity Reservation preferences. Possible preferences include:
\n\n open - The instance can run in any open Capacity Reservation that\n has matching attributes (instance type, platform, Availability Zone).
\n none - The instance avoids running in a Capacity Reservation even if one is\n available. The instance runs in On-Demand capacity.
Describes the instance's Capacity Reservation preferences. Possible preferences include:
\n\n open - The instance can run in any open Capacity Reservation that\n has matching attributes (instance type, platform, Availability Zone).
\n none - The instance avoids running in a Capacity Reservation even if one is\n available. The instance runs in On-Demand capacity.
We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n\tDescribes a linked EC2-Classic instance.
" + "smithy.api#documentation": "We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes a linked EC2-Classic instance.
" } }, "com.amazonaws.ec2#ClassicLinkInstanceList": { @@ -11677,7 +11668,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "Enable or disable a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.
\n\t\tValid values: true | false\n
Default value: false\n
Enable or disable a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.
\nValid values: true | false\n
Default value: false\n
Current state of text banner feature.
\n\t\tValid values: true | false\n
Current state of text banner feature.
\nValid values: true | false\n
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
\n\t\tFor information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint \n\t\t\tin the Client VPN Administrator Guide.
", + "smithy.api#documentation": "Indicates whether split-tunnel is enabled in the Client VPN endpoint.
\nFor information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint \n\t\t\tin the Client VPN Administrator Guide.
", "smithy.api#xmlName": "splitTunnel" } }, @@ -12249,7 +12240,7 @@ "aws.protocols#ec2QueryName": "SessionTimeoutHours", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The maximum VPN session duration time in hours.
\n\t\tValid values: 8 | 10 | 12 | 24\n
Default value: 24\n
The maximum VPN session duration time in hours.
\nValid values: 8 | 10 | 12 | 24\n
Default value: 24\n
The state of the Client VPN endpoint. Possible states include:
\n\t\t\n pending-associate - The Client VPN endpoint has been created but no target networks \n\t\t\t\t\thave been associated. The Client VPN endpoint cannot accept connections.
\n available - The Client VPN endpoint has been created and a target network has been\n\t\t\t\t\tassociated. The Client VPN endpoint can accept connections.
\n deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept\n\t\t\t\t\tconnections.
\n deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept\n\t\t\t\t\tconnections.
The state of the Client VPN endpoint. Possible states include:
\n\n pending-associate - The Client VPN endpoint has been created but no target networks \n\t\t\t\t\thave been associated. The Client VPN endpoint cannot accept connections.
\n available - The Client VPN endpoint has been created and a target network has been\n\t\t\t\t\tassociated. The Client VPN endpoint can accept connections.
\n deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept\n\t\t\t\t\tconnections.
\n deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept\n\t\t\t\t\tconnections.
Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False\n
Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False\n
Configured log format. Default format is json.
Valid values: json | text\n
Configured log format. Default format is json.
Valid values: json | text\n
Enable or disable VPN tunnel logging feature. Default value is False.
Valid values: True | False\n
Enable or disable VPN tunnel logging feature. Default value is False.
Valid values: True | False\n
Set log format. Default format is json.
Valid values: json | text\n
Set log format. Default format is json.
Valid values: json | text\n
Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
\n \t\n \tTo copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
\n \nFor more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
\nTo copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
\nFor more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CopyImageRequest": { @@ -13225,7 +13216,7 @@ "target": "com.amazonaws.ec2#KmsKeyId", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating\n \t\tencrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. \n \t\tIf you specify a KMS key, you must also set the encrypted state to true.
You can specify a KMS key using any of the following:
\n \tKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\n \t\tKey alias. For example, alias/ExampleAlias.
\n \tKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\n \t\tAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\n \t\tAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid,\n the action can appear to complete, but eventually fails.
\n \tThe specified KMS key must exist in the destination Region.
\n \tAmazon EBS does not support asymmetric KMS keys.
", + "smithy.api#documentation": "The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating\n \t\tencrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. \n \t\tIf you specify a KMS key, you must also set the encrypted state to true.
You can specify a KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid,\n the action can appear to complete, but eventually fails.
\nThe specified KMS key must exist in the destination Region.
\nAmazon EBS does not support asymmetric KMS keys.
", "smithy.api#xmlName": "kmsKeyId" } }, @@ -13256,7 +13247,7 @@ "DestinationOutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.
\n \tFor more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.
\nFor more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
" } }, "DryRun": { @@ -13307,7 +13298,7 @@ "target": "com.amazonaws.ec2#CopySnapshotResult" }, "traits": { - "smithy.api#documentation": "Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.
\nYou can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
\n \n \t\nWhen copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) \n \tKMS key; however, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.
\n \t\n \tSnapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
\nSnapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.
\nFor more information, see Copy an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.
\nYou can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
\nWhen copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) \n \tKMS key; however, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.
\nSnapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
\nSnapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.
\nFor more information, see Copy an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CopySnapshotRequest": { @@ -13322,14 +13313,14 @@ "DestinationOutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only \n\t\tspecify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. \n\t\tThe snapshot must be in the Region for the destination Outpost. You cannot copy a \n\t\tsnapshot from an Outpost to a Region, from one Outpost to another, or within the same \n\t\tOutpost.
\n \tFor more information, see \n \t\tCopy snapshots from an Amazon Web Services Region to an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only \n\t\tspecify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. \n\t\tThe snapshot must be in the Region for the destination Outpost. You cannot copy a \n\t\tsnapshot from an Outpost to a Region, from one Outpost to another, or within the same \n\t\tOutpost.
\nFor more information, see \n \t\tCopy snapshots from an Amazon Web Services Region to an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.
" } }, "DestinationRegion": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "DestinationRegion", - "smithy.api#documentation": "The destination Region to use in the PresignedUrl parameter of a snapshot\n copy operation. This parameter is only valid for specifying the destination Region in a\n PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP\n \trequest to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is\n specified using the --region parameter or the default Region in your Amazon Web Services\n configuration file.
The destination Region to use in the PresignedUrl parameter of a snapshot\n copy operation. This parameter is only valid for specifying the destination Region in a\n PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP\n \trequest to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is\n specified using the --region parameter or the default Region in your Amazon Web Services\n configuration file.
Creates a new Capacity Reservation with the specified attributes.
\n\t\tCapacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This \n\t\t\tgives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. \n\t\t\tBy creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. \n\t\t\tFor more information, see Capacity Reservations in the Amazon EC2 User Guide.
\n\t\t\n\t\tYour request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to\n\t\t\tfulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try\n\t\t\tagain at a later time, try in a different Availability Zone, or request a smaller\n\t\t\tcapacity reservation. If your application is flexible across instance types and sizes,\n\t\t\ttry to create a Capacity Reservation with different instance attributes.
\n\t\t\n\t\tYour request could also fail if the requested quantity exceeds your On-Demand Instance\n\t\t\tlimit for the selected instance type. If your request fails due to limit constraints,\n\t\t\tincrease your On-Demand Instance limit for the required instance type and try again. For\n\t\t\tmore information about increasing your instance limits, see Amazon EC2 Service\n\t\t\t\tQuotas in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Creates a new Capacity Reservation with the specified attributes.
\nCapacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This \n\t\t\tgives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. \n\t\t\tBy creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. \n\t\t\tFor more information, see Capacity Reservations in the Amazon EC2 User Guide.
\nYour request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to\n\t\t\tfulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try\n\t\t\tagain at a later time, try in a different Availability Zone, or request a smaller\n\t\t\tcapacity reservation. If your application is flexible across instance types and sizes,\n\t\t\ttry to create a Capacity Reservation with different instance attributes.
\nYour request could also fail if the requested quantity exceeds your On-Demand Instance\n\t\t\tlimit for the selected instance type. If your request fails due to limit constraints,\n\t\t\tincrease your On-Demand Instance limit for the required instance type and try again. For\n\t\t\tmore information about increasing your instance limits, see Amazon EC2 Service\n\t\t\t\tQuotas in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateCapacityReservationFleet": { @@ -13555,7 +13546,7 @@ "AllocationStrategy": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The strategy used by the Capacity Reservation Fleet to determine which of the \n\t\t\tspecified instance types to use. Currently, only the prioritized \n\t\t\tallocation strategy is supported. For more information, see \n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.
Valid values: prioritized\n
The strategy used by the Capacity Reservation Fleet to determine which of the \n\t\t\tspecified instance types to use. Currently, only the prioritized \n\t\t\tallocation strategy is supported. For more information, see \n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.
Valid values: prioritized\n
Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations \n\t\t\tin the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of \n\t\t\tthe following tenancy settings:
\n\t\t\n\t\t\t\t\t default - The Capacity Reservation Fleet is created on hardware \n\t\t\t\t\tthat is shared with other Amazon Web Services accounts.
\n\t\t\t\t\t dedicated - The Capacity Reservations are created on single-tenant \n\t\t\t\t\thardware that is dedicated to a single Amazon Web Services account.
Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations \n\t\t\tin the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of \n\t\t\tthe following tenancy settings:
\n\n default - The Capacity Reservation Fleet is created on hardware \n\t\t\t\t\tthat is shared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservations are created on single-tenant \n\t\t\t\t\thardware that is dedicated to a single Amazon Web Services account.
The date and time at which the Capacity Reservation Fleet expires. When the Capacity \n\t\t\tReservation Fleet expires, its state changes to expired and all of the Capacity \n\t\t\tReservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, \n\t\t\tif you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet \n\t\t\tis guaranteed to expire between 13:30:55 and 14:30:55 on \n\t\t\t5/31/2019.\n\t\t
The date and time at which the Capacity Reservation Fleet expires. When the Capacity \n\t\t\tReservation Fleet expires, its state changes to expired and all of the Capacity \n\t\t\tReservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, \n\t\t\tif you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet \n\t\t\tis guaranteed to expire between 13:30:55 and 14:30:55 on \n\t\t\t5/31/2019.\n\t\t
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.
\n\t\tCurrently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.
\nCurrently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
\n\t\t\n default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
\n\n default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The number of instances for which to reserve capacity.
\n\t \tValid range: 1 - 1000
", + "smithy.api#documentation": "The number of instances for which to reserve capacity.
\nValid range: 1 - 1000
", "smithy.api#required": {} } }, @@ -13786,19 +13777,19 @@ "EndDate": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.
If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.
If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:
\n\t\t\n unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not\n\t\t\t\t\tprovide an EndDate if the EndDateType is\n\t\t\t\t\t\tunlimited.
\n limited - The Capacity Reservation expires automatically at a specified date and time. You must\n\t\t\t\t\tprovide an EndDate value if the EndDateType value is\n\t\t\t\t\t\tlimited.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:
\n\n unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not\n\t\t\t\t\tprovide an EndDate if the EndDateType is\n\t\t\t\t\t\tunlimited.
\n limited - The Capacity Reservation expires automatically at a specified date and time. You must\n\t\t\t\t\tprovide an EndDate value if the EndDateType value is\n\t\t\t\t\t\tlimited.
Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:
\n\t\t\n open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, \n\t\t\t\tand Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying \n\t\t\t\tany additional parameters.
\n targeted - The Capacity Reservation only accepts instances that have matching attributes\n\t\t\t\t\t(instance type, platform, and Availability Zone), and explicitly target the\n\t\t\t\t\tCapacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open\n
Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:
\n\n open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, \n\t\t\t\tand Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying \n\t\t\t\tany additional parameters.
\n targeted - The Capacity Reservation only accepts instances that have matching attributes\n\t\t\t\t\t(instance type, platform, and Availability Zone), and explicitly target the\n\t\t\t\t\tCapacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open\n
Information about the client connection logging options.
\n\t\tIf you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:
\n\t\tClient connection requests
\nClient connection results (successful and unsuccessful)
\nReasons for unsuccessful client connection requests
\nClient connection termination time
\nInformation about the client connection logging options.
\nIf you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:
\nClient connection requests
\nClient connection results (successful and unsuccessful)
\nReasons for unsuccessful client connection requests
\nClient connection termination time
\nThe transport protocol to be used by the VPN session.
\n\t\tDefault value: udp\n
The transport protocol to be used by the VPN session.
\nDefault value: udp\n
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
\n\tValid Values: 443 | 1194\n
Default Value: 443\n
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
\nValid Values: 443 | 1194\n
Default Value: 443\n
Indicates whether split-tunnel is enabled on the Client VPN endpoint.
\n\t\tBy default, split-tunnel on a VPN endpoint is disabled.
\n\t\tFor information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n\t\t\tClient VPN Administrator Guide.
" + "smithy.api#documentation": "Indicates whether split-tunnel is enabled on the Client VPN endpoint.
\nBy default, split-tunnel on a VPN endpoint is disabled.
\nFor information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n\t\t\tClient VPN Administrator Guide.
" } }, "DryRun": { @@ -14022,7 +14013,7 @@ "SelfServicePortal": { "target": "com.amazonaws.ec2#SelfServicePortal", "traits": { - "smithy.api#documentation": "Specify whether to enable the self-service portal for the Client VPN endpoint.
\nDefault Value: enabled\n
Specify whether to enable the self-service portal for the Client VPN endpoint.
\nDefault Value: enabled\n
The maximum VPN session duration time in hours.
\n\t\tValid values: 8 | 10 | 12 | 24\n
Default value: 24\n
The maximum VPN session duration time in hours.
\nValid values: 8 | 10 | 12 | 24\n
Default value: 24\n
The IPv4 address range, in CIDR notation, of the route destination. For example:
\n\t\tTo add a route for Internet access, enter 0.0.0.0/0\n
To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
\nTo add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range
\nTo add a route for the local network, enter the client CIDR range
\nThe IPv4 address range, in CIDR notation, of the route destination. For example:
\nTo add a route for Internet access, enter 0.0.0.0/0\n
To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
\nTo add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range
\nTo add a route for the local network, enter the client CIDR range
\nThe ID of the subnet through which you want to route traffic. The specified subnet must be\n\t\t\tan existing target network of the Client VPN endpoint.
\n\tAlternatively, if you're adding a route for the local network, specify local.
The ID of the subnet through which you want to route traffic. The specified subnet must be\n\t\t\tan existing target network of the Client VPN endpoint.
\nAlternatively, if you're adding a route for the local network, specify local.
Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).
\nFor devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
\nTo create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.
" + "smithy.api#documentation": "Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).
\nFor devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
\nTo create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.
" } }, "com.amazonaws.ec2#CreateCustomerGatewayRequest": { @@ -14278,7 +14269,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "For devices that support BGP, the customer gateway's BGP ASN.
\nDefault: 65000
", + "smithy.api#documentation": "For devices that support BGP, the customer gateway's BGP ASN.
\nDefault: 65000
", "smithy.api#required": {} } }, @@ -14312,7 +14303,7 @@ "DeviceName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A name for the customer gateway device.
\nLength Constraints: Up to 255 characters.
" + "smithy.api#documentation": "A name for the customer gateway device.
\nLength Constraints: Up to 255 characters.
" } }, "IpAddress": { @@ -14415,7 +14406,7 @@ "target": "com.amazonaws.ec2#CreateDefaultVpcResult" }, "traits": { - "smithy.api#documentation": "Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet\n\t\t\tin each Availability Zone. For more information about the components of a default VPC,\n\t\t\tsee Default VPC and\n\t\t\tdefault subnets in the Amazon Virtual Private Cloud User Guide. You cannot\n\t\t\tspecify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have\n\t\t\tmore than one default VPC per Region.
\n\t\tIf your account supports EC2-Classic, you cannot use this action to create a default VPC\n\t\t\tin a Region that supports EC2-Classic. If you want a default VPC in a Region that\n\t\t\tsupports EC2-Classic, see \"I really want a default VPC for my existing EC2 account. Is\n\t\t\tthat possible?\" in the Default VPCs\n\t\t\tFAQ.
\n\tWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n\tCreates a default VPC with a size /16 IPv4 CIDR block and a default subnet\n\t\t\tin each Availability Zone. For more information about the components of a default VPC,\n\t\t\tsee Default VPC and\n\t\t\tdefault subnets in the Amazon Virtual Private Cloud User Guide. You cannot\n\t\t\tspecify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have\n\t\t\tmore than one default VPC per Region.
\nIf your account supports EC2-Classic, you cannot use this action to create a default VPC\n\t\t\tin a Region that supports EC2-Classic. If you want a default VPC in a Region that\n\t\t\tsupports EC2-Classic, see \"I really want a default VPC for my existing EC2 account. Is\n\t\t\tthat possible?\" in the Default VPCs\n\t\t\tFAQ.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nCreates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.
\n\n domain-name-servers - The IP addresses of up to four domain name\n servers, or AmazonProvidedDNS. The default DHCP option set specifies\n AmazonProvidedDNS. If specifying more than one domain name server, specify the\n IP addresses in a single parameter, separated by commas. To have your instance\n receive a custom DNS hostname as specified in domain-name, you must\n set domain-name-servers to a custom DNS server.
\n domain-name - If you're using AmazonProvidedDNS in\n us-east-1, specify ec2.internal. If you're using\n AmazonProvidedDNS in another Region, specify\n region.compute.internal (for example,\n ap-northeast-1.compute.internal). Otherwise, specify a domain\n name (for example, ExampleCompany.com). This value is used to complete\n unqualified DNS hostnames. Important: Some\n Linux operating systems accept multiple domain names separated by spaces.\n However, Windows and other Linux operating systems treat the value as a single\n domain, which results in unexpected behavior. If your DHCP options set is\n associated with a VPC that has instances with multiple operating systems,\n specify only one domain name.
\n ntp-servers - The IP addresses of up to four Network Time Protocol (NTP)\n servers.
\n netbios-name-servers - The IP addresses of up to four NetBIOS name\n servers.
\n netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2 (broadcast and multicast are not currently supported). For more information\n about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS\n\t\t\tserver that we provide (AmazonProvidedDNS). If you create a set of options, and if your\n\t\t\tVPC has an internet gateway, make sure to set the domain-name-servers\n\t\t\toption either to AmazonProvidedDNS or to a domain name server of your\n\t\t\tchoice. For more information, see DHCP options sets in the\n\t\t\tAmazon Virtual Private Cloud User Guide.
Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.
\n\n domain-name-servers - The IP addresses of up to four domain name\n servers, or AmazonProvidedDNS. The default DHCP option set specifies\n AmazonProvidedDNS. If specifying more than one domain name server, specify the\n IP addresses in a single parameter, separated by commas. To have your instance\n receive a custom DNS hostname as specified in domain-name, you must\n set domain-name-servers to a custom DNS server.
\n domain-name - If you're using AmazonProvidedDNS in\n us-east-1, specify ec2.internal. If you're using\n AmazonProvidedDNS in another Region, specify\n region.compute.internal (for example,\n ap-northeast-1.compute.internal). Otherwise, specify a domain\n name (for example, ExampleCompany.com). This value is used to complete\n unqualified DNS hostnames. Important: Some\n Linux operating systems accept multiple domain names separated by spaces.\n However, Windows and other Linux operating systems treat the value as a single\n domain, which results in unexpected behavior. If your DHCP options set is\n associated with a VPC that has instances with multiple operating systems,\n specify only one domain name.
\n ntp-servers - The IP addresses of up to four Network Time Protocol (NTP)\n servers.
\n netbios-name-servers - The IP addresses of up to four NetBIOS name\n servers.
\n netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2 (broadcast and multicast are not currently supported). For more information\n about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS\n\t\t\tserver that we provide (AmazonProvidedDNS). If you create a set of options, and if your\n\t\t\tVPC has an internet gateway, make sure to set the domain-name-servers\n\t\t\toption either to AmazonProvidedDNS or to a domain name server of your\n\t\t\tchoice. For more information, see DHCP options sets in the\n\t\t\tAmazon Virtual Private Cloud User Guide.
Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.
\n \nFlow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon Virtual Private Cloud User Guide.
\n \nWhen publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.
\n \nFor more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.
\nFlow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon Virtual Private Cloud User Guide.
\nWhen publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.
\nFor more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateFlowLogsRequest": { @@ -14847,7 +14838,7 @@ "DeliverLogsPermissionArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in\n your account.
\nThis parameter is required if the destination type is cloud-watch-logs\n and unsupported otherwise.
The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in\n your account.
\nThis parameter is required if the destination type is cloud-watch-logs\n and unsupported otherwise.
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
\nThis parameter is valid only if the destination type is cloud-watch-logs.
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
\nThis parameter is valid only if the destination type is cloud-watch-logs.
The IDs of the resources to monitor. For example, if the resource type is\n VPC, specify the IDs of the VPCs.
Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the\n other resource types.
", + "smithy.api#documentation": "The IDs of the resources to monitor. For example, if the resource type is\n VPC, specify the IDs of the VPCs.
Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the\n other resource types.
", "smithy.api#required": {}, "smithy.api#xmlName": "ResourceId" } @@ -14888,19 +14879,19 @@ "LogDestinationType": { "target": "com.amazonaws.ec2#LogDestinationType", "traits": { - "smithy.api#documentation": "The type of destination for the flow log data.
\nDefault: cloud-watch-logs\n
The type of destination for the flow log data.
\nDefault: cloud-watch-logs\n
The destination for the flow log data. The meaning of this parameter depends on the destination type.
\nIf the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:
arn:aws:logs:region:account_id:log-group:my_group\n
\nAlternatively, use the LogGroupName parameter.
If the destination type is s3, specify the ARN of an S3 bucket. For example:
arn:aws:s3:::my_bucket/my_subfolder/
\nThe subfolder is optional. Note that you can't use AWSLogs as a subfolder name.
If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:
arn:aws:firehose:region:account_id:deliverystream:my_stream\n
\nThe destination for the flow log data. The meaning of this parameter depends on the destination type.
\nIf the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:
arn:aws:logs:region:account_id:log-group:my_group\n
\nAlternatively, use the LogGroupName parameter.
If the destination type is s3, specify the ARN of an S3 bucket. For example:
arn:aws:s3:::my_bucket/my_subfolder/
\nThe subfolder is optional. Note that you can't use AWSLogs as a subfolder name.
If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:
arn:aws:firehose:region:account_id:deliverystream:my_stream\n
\nThe fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.
\nSpecify the fields using the ${field-id} format, separated by spaces. For\n the CLI, surround this parameter value with single quotes on Linux or\n double quotes on Windows.
The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.
\nSpecify the fields using the ${field-id} format, separated by spaces. For\n the CLI, surround this parameter value with single quotes on Linux or\n double quotes on Windows.
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. \n The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\n This parameter must be 60 seconds for transit gateway resource types.
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.
\nDefault: 600
" + "smithy.api#documentation": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. \n The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\n This parameter must be 60 seconds for transit gateway resource types.
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.
\nDefault: 600
" } }, "DestinationOptions": { @@ -15049,7 +15040,7 @@ "target": "com.amazonaws.ec2#CreateImageResult" }, "traits": { - "smithy.api#documentation": "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.
\n\tBy default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.
\n \tFor more information, see Create an Amazon EBS-backed Linux\n AMI in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.
\nBy default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.
\nFor more information, see Create an Amazon EBS-backed Linux\n AMI in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateImageRequest": { @@ -15107,14 +15098,14 @@ "aws.protocols#ec2QueryName": "NoReboot", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.
Default: false (follow standard reboot process)
By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.
Default: false (follow standard reboot process)
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.
\nTo tag the AMI, the value for ResourceType must be\n image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that\n are attached to the instance, the value for ResourceType must be\n snapshot. The same tag is applied to all of the snapshots that are\n created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", + "smithy.api#documentation": "The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.
\nTo tag the AMI, the value for ResourceType must be\n image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that\n are attached to the instance, the value for ResourceType must be\n snapshot. The same tag is applied to all of the snapshots that are\n created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", "smithy.api#xmlName": "TagSpecification" } } @@ -15142,7 +15133,7 @@ "target": "com.amazonaws.ec2#CreateInstanceEventWindowResult" }, "traits": { - "smithy.api#documentation": "Creates an event window in which scheduled events for the associated Amazon EC2 instances can\n run.
\nYou can define either a set of time ranges or a cron expression when creating the event\n window, but not both. All event window times are in UTC.
\nYou can create up to 200 event windows per Amazon Web Services Region.
\nWhen you create the event window, targets (instance IDs, Dedicated Host IDs, or tags)\n are not yet associated with it. To ensure that the event window can be used, you must\n associate one or more targets with it by using the AssociateInstanceEventWindow API.
\n \nEvent windows are applicable only for scheduled events that stop, reboot, or\n terminate instances.
\nEvent windows are not applicable for:
\nExpedited scheduled events and network maintenance events.
\nUnscheduled maintenance such as AutoRecovery and unplanned reboots.
\nFor more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Creates an event window in which scheduled events for the associated Amazon EC2 instances can\n run.
\nYou can define either a set of time ranges or a cron expression when creating the event\n window, but not both. All event window times are in UTC.
\nYou can create up to 200 event windows per Amazon Web Services Region.
\nWhen you create the event window, targets (instance IDs, Dedicated Host IDs, or tags)\n are not yet associated with it. To ensure that the event window can be used, you must\n associate one or more targets with it by using the AssociateInstanceEventWindow API.
\nEvent windows are applicable only for scheduled events that stop, reboot, or\n terminate instances.
\nEvent windows are not applicable for:
\nExpedited scheduled events and network maintenance events.
\nUnscheduled maintenance such as AutoRecovery and unplanned reboots.
\nFor more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateInstanceEventWindowRequest": { @@ -15598,7 +15589,7 @@ "target": "com.amazonaws.ec2#KeyPair" }, "traits": { - "smithy.api#documentation": "Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified PEM or PPK format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.
\n\t\tThe key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.
\nYou can have up to 5,000 key pairs per Amazon Web Services Region.
\nFor more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified PEM or PPK format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.
\nThe key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.
\nYou can have up to 5,000 key pairs per Amazon Web Services Region.
\nFor more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateKeyPairRequest": { @@ -15608,7 +15599,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique name for the key pair.
\n\tConstraints: Up to 255 ASCII characters
", + "smithy.api#documentation": "A unique name for the key pair.
\nConstraints: Up to 255 ASCII characters
", "smithy.api#required": {} } }, @@ -15625,7 +15616,7 @@ "KeyType": { "target": "com.amazonaws.ec2#KeyType", "traits": { - "smithy.api#documentation": "The type of key pair. Note that ED25519 keys are not supported for Windows instances.
\nDefault: rsa\n
The type of key pair. Note that ED25519 keys are not supported for Windows instances.
\nDefault: rsa\n
The format of the key pair.
\nDefault: pem\n
The format of the key pair.
\nDefault: pem\n
Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateLaunchTemplateRequest": { @@ -15669,7 +15660,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
" + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
" } }, "LaunchTemplateName": { @@ -15697,7 +15688,7 @@ "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.
To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch\n template data structure.
The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.
To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch\n template data structure.
Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.
\nLaunch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.
\nFor more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.
\nLaunch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.
\nFor more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest": { @@ -15750,19 +15741,19 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
" + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
" } }, "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The name of the launch template.
\nYou must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.
A name for the prefix list.
\nConstraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
A name for the prefix list.
\nConstraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
The IP address type.
\nValid Values: IPv4 | IPv6\n
The IP address type.
\nValid Values: IPv4 | IPv6\n
Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.
\nConstraints: Up to 255 UTF-8 characters in length.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.
\nConstraints: Up to 255 UTF-8 characters in length.
", "smithy.api#idempotencyToken": {} } } @@ -16148,7 +16139,7 @@ "target": "com.amazonaws.ec2#CreateNatGatewayResult" }, "traits": { - "smithy.api#documentation": "Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.
\nWith a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.
\nWith a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.
\nFor more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.
\nWith a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.
\nWith a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.
\nFor more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateNatGatewayRequest": { @@ -16234,7 +16225,7 @@ "target": "com.amazonaws.ec2#CreateNetworkAclResult" }, "traits": { - "smithy.api#documentation": "Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
\n\t\tFor more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
\nFor more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateNetworkAclEntry": { @@ -16246,7 +16237,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules \n\t\t and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated \n\t\t with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of \n\t\t ingress rules and a separate set of egress rules.
\n\t\tWe recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the \n\t\t other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
\n\t\tAfter you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
\nFor more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules \n\t\t and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated \n\t\t with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of \n\t\t ingress rules and a separate set of egress rules.
\nWe recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the \n\t\t other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
\nAfter you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
\nFor more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateNetworkAclEntryRequest": { @@ -16575,7 +16566,7 @@ "target": "com.amazonaws.ec2#CreateNetworkInterfaceResult" }, "traits": { - "smithy.api#documentation": "Creates a network interface in the specified subnet.
\nThe number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.
\nFor more information about network interfaces, see Elastic network interfaces \n in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a network interface in the specified subnet.
\nThe number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.
\nFor more information about network interfaces, see Elastic network interfaces \n in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateNetworkInterfacePermission": { @@ -16587,7 +16578,7 @@ "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult" }, "traits": { - "smithy.api#documentation": "Grants an Amazon Web Services-authorized account permission to attach the specified network interface to\n an instance in their account.
\n\tYou can grant permission to a single Amazon Web Services account only, and only one account at a time.
" + "smithy.api#documentation": "Grants an Amazon Web Services-authorized account permission to attach the specified network interface to\n an instance in their account.
\nYou can grant permission to a single Amazon Web Services account only, and only one account at a time.
" } }, "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest": { @@ -16684,7 +16675,7 @@ "aws.protocols#ec2QueryName": "Ipv6AddressCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.
\nYou can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
\nIf your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.
The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.
\nYou can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
\nIf your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.
The IPv6 addresses from the IPv6 CIDR block range of your subnet.
\nYou can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
", + "smithy.api#documentation": "The IPv6 addresses from the IPv6 CIDR block range of your subnet.
\nYou can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
", "smithy.api#xmlName": "ipv6Addresses" } }, @@ -16708,7 +16699,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddresses", - "smithy.api#documentation": "The private IPv4 addresses.
\nYou can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", + "smithy.api#documentation": "The private IPv4 addresses.
\nYou can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", "smithy.api#xmlName": "privateIpAddresses" } }, @@ -16718,14 +16709,14 @@ "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", + "smithy.api#documentation": "The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", "smithy.api#xmlName": "secondaryPrivateIpAddressCount" } }, "Ipv4Prefixes": { "target": "com.amazonaws.ec2#Ipv4PrefixList", "traits": { - "smithy.api#documentation": "The IPv4 prefixes assigned to the network interface.
\nYou can't specify IPv4 prefixes if you've specified one of the following:\n a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
", + "smithy.api#documentation": "The IPv4 prefixes assigned to the network interface.
\nYou can't specify IPv4 prefixes if you've specified one of the following:\n a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
", "smithy.api#xmlName": "Ipv4Prefix" } }, @@ -16734,13 +16725,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.
\nYou can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.
" + "smithy.api#documentation": "The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.
\nYou can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.
" } }, "Ipv6Prefixes": { "target": "com.amazonaws.ec2#Ipv6PrefixList", "traits": { - "smithy.api#documentation": "The IPv6 prefixes assigned to the network interface.
\nYou can't specify IPv6 prefixes if you've specified one of the following:\n a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
", + "smithy.api#documentation": "The IPv6 prefixes assigned to the network interface.
\nYou can't specify IPv6 prefixes if you've specified one of the following:\n a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
", "smithy.api#xmlName": "Ipv6Prefix" } }, @@ -16749,13 +16740,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.
\nYou can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
" + "smithy.api#documentation": "The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.
\nYou can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
" } }, "InterfaceType": { "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", "traits": { - "smithy.api#documentation": "The type of network interface. The default is interface.
The only supported values are efa and trunk.
The type of network interface. The default is interface.
The only supported values are efa and trunk.
Creates a placement group in which to launch instances. The strategy of the placement\n group determines how the instances are organized within the group.
\nA cluster placement group is a logical grouping of instances within a\n single Availability Zone that benefit from low network latency, high network throughput.\n A spread placement group places instances on distinct hardware. A\n partition placement group places groups of instances in different\n partitions, where instances in one partition do not share the same hardware with\n instances in another partition.
For more information, see Placement groups in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Creates a placement group in which to launch instances. The strategy of the placement\n group determines how the instances are organized within the group.
\nA cluster placement group is a logical grouping of instances within a\n single Availability Zone that benefit from low network latency, high network throughput.\n A spread placement group places instances on distinct hardware. A\n partition placement group places groups of instances in different\n partitions, where instances in one partition do not share the same hardware with\n instances in another partition.
For more information, see Placement groups in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreatePlacementGroupRequest": { @@ -16834,7 +16825,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "A name for the placement group. Must be unique within the scope of your account for\n the Region.
\nConstraints: Up to 255 ASCII characters
", + "smithy.api#documentation": "A name for the placement group. Must be unique within the scope of your account for\n the Region.
\nConstraints: Up to 255 ASCII characters
", "smithy.api#xmlName": "groupName" } }, @@ -16864,7 +16855,7 @@ "SpreadLevel": { "target": "com.amazonaws.ec2#SpreadLevel", "traits": { - "smithy.api#documentation": "Determines how placement groups spread instances.
\nHost – You can use host only with Outpost placement\n groups.
Rack – No usage restrictions.
\nDetermines how placement groups spread instances.
\nHost – You can use host only with Outpost placement\n groups.
Rack – No usage restrictions.
\nReplaces the EBS-backed root volume for a running instance with a new \n volume that is restored to the original root volume's launch state, that is restored to a \n specific snapshot taken from the original root volume, or that is restored from an AMI \n that has the same key characteristics as that of the instance.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Replaces the EBS-backed root volume for a running instance with a new \n volume that is restored to the original root volume's launch state, that is restored to a \n specific snapshot taken from the original root volume, or that is restored from an AMI \n that has the same key characteristics as that of the instance.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateReplaceRootVolumeTaskRequest": { @@ -17016,7 +17007,7 @@ "target": "com.amazonaws.ec2#CreateReservedInstancesListingResult" }, "traits": { - "smithy.api#documentation": "Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.
\nOnly Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.
\nThe Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\n\t\tTo sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.
\nFor more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon EC2 User Guide.
" + "smithy.api#documentation": "Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.
\nOnly Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.
\nThe Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nTo sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.
\nFor more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateReservedInstancesListingRequest": { @@ -17160,7 +17151,7 @@ "target": "com.amazonaws.ec2#CreateRouteResult" }, "traits": { - "smithy.api#documentation": "Creates a route in a route table within a VPC.
\nYou must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list.
\nWhen determining how to route traffic, we use the route with the most specific match.\n For example, traffic is destined for the IPv4 address 192.0.2.3, and the\n route table includes the following two IPv4 routes:
\n 192.0.2.0/24 (goes to some target A)
\n 192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.
For more information about route tables, see Route tables in the\n Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates a route in a route table within a VPC.
\nYou must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list.
\nWhen determining how to route traffic, we use the route with the most specific match.\n For example, traffic is destined for the IPv4 address 192.0.2.3, and the\n route table includes the following two IPv4 routes:
\n 192.0.2.0/24 (goes to some target A)
\n 192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.
For more information about route tables, see Route tables in the\n Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateRouteRequest": { @@ -17251,7 +17242,7 @@ "CarrierGatewayId": { "target": "com.amazonaws.ec2#CarrierGatewayId", "traits": { - "smithy.api#documentation": "The ID of the carrier gateway.
\nYou can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
" + "smithy.api#documentation": "The ID of the carrier gateway.
\nYou can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
" } }, "NetworkInterfaceId": { @@ -17369,7 +17360,7 @@ "target": "com.amazonaws.ec2#CreateSecurityGroupResult" }, "traits": { - "smithy.api#documentation": "Creates a security group.
\nA security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWhen you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
\nYou have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
\nYou can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.
\nFor more information about VPC security group limits, see Amazon VPC Limits.
\n \nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nCreates a security group.
\nA security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWhen you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
\nYou have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
\nYou can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.
\nFor more information about VPC security group limits, see Amazon VPC Limits.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nA description for the security group. This is informational only.
\n\t\tConstraints: Up to 255 characters in length
\n\t\tConstraints for EC2-Classic: ASCII characters
\n\t\tConstraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", + "smithy.api#documentation": "A description for the security group. This is informational only.
\nConstraints: Up to 255 characters in length
\nConstraints for EC2-Classic: ASCII characters
\nConstraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", "smithy.api#required": {}, "smithy.api#xmlName": "GroupDescription" } @@ -17447,7 +17438,7 @@ "target": "com.amazonaws.ec2#Snapshot" }, "traits": { - "smithy.api#documentation": "Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.
\n \n \nYou can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.
\n \t\nWhen a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.
\nYou can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the\n instance before taking the snapshot.
\nSnapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.
\nYou can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.
\nYou can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.
\nWhen a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.
\nYou can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the\n instance before taking the snapshot.
\nSnapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.
\nYou can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateSnapshotRequest": { @@ -17462,7 +17453,7 @@ "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost on which to create a local \n \tsnapshot.
\n \tTo create a snapshot of a volume in a Region, omit this parameter. The snapshot \n \t\t\t\tis created in the same Region as the volume.
\n \t\tTo create a snapshot of a volume on an Outpost and store the snapshot in the \n \t\t\t\tRegion, omit this parameter. The snapshot is created in the Region for the \n \t\t\t\tOutpost.
\n \t\tTo create a snapshot of a volume on an Outpost and store the snapshot on an \n \t\t\tOutpost, specify the ARN of the destination Outpost. The snapshot must be created on \n \t\t\tthe same Outpost as the volume.
\n \t\tFor more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost on which to create a local \n \tsnapshot.
\nTo create a snapshot of a volume in a Region, omit this parameter. The snapshot \n \t\t\t\tis created in the same Region as the volume.
\nTo create a snapshot of a volume on an Outpost and store the snapshot in the \n \t\t\t\tRegion, omit this parameter. The snapshot is created in the Region for the \n \t\t\t\tOutpost.
\nTo create a snapshot of a volume on an Outpost and store the snapshot on an \n \t\t\tOutpost, specify the ARN of the destination Outpost. The snapshot must be created on \n \t\t\tthe same Outpost as the volume.
\nFor more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.
" } }, "VolumeId": { @@ -17501,7 +17492,7 @@ "target": "com.amazonaws.ec2#CreateSnapshotsResult" }, "traits": { - "smithy.api#documentation": "Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.\n Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot\n each that is crash-consistent across the instance.
\n \nYou can include all of the volumes currently attached to the instance, or you can exclude \n the root volume or specific data (non-root) volumes from the multi-volume snapshot set.
\n \t\nYou can create multi-volume snapshots of instances in a Region and instances on an \n \tOutpost. If you create snapshots from an instance in a Region, the snapshots must be stored \n \tin the same Region as the instance. If you create snapshots from an instance on an Outpost, \n \tthe snapshots can be stored on the same Outpost as the instance, or in the Region for that \n \tOutpost.
" + "smithy.api#documentation": "Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.\n Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot\n each that is crash-consistent across the instance.
\nYou can include all of the volumes currently attached to the instance, or you can exclude \n the root volume or specific data (non-root) volumes from the multi-volume snapshot set.
\nYou can create multi-volume snapshots of instances in a Region and instances on an \n \tOutpost. If you create snapshots from an instance in a Region, the snapshots must be stored \n \tin the same Region as the instance. If you create snapshots from an instance on an Outpost, \n \tthe snapshots can be stored on the same Outpost as the instance, or in the Region for that \n \tOutpost.
" } }, "com.amazonaws.ec2#CreateSnapshotsRequest": { @@ -17524,7 +17515,7 @@ "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost on which to create the local \n \t\tsnapshots.
\n \tTo create snapshots from an instance in a Region, omit this parameter. The \n \t\t\t\tsnapshots are created in the same Region as the instance.
\n \t\tTo create snapshots from an instance on an Outpost and store the snapshots \n \t\t\t\tin the Region, omit this parameter. The snapshots are created in the Region \n \t\t\t\tfor the Outpost.
\n \t\tTo create snapshots from an instance on an Outpost and store the snapshots \n \t\t\t\ton an Outpost, specify the ARN of the destination Outpost. The snapshots must \n \t\t\t\tbe created on the same Outpost as the instance.
\n \t\tFor more information, see \n \t\tCreate multi-volume local snapshots from instances on an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost on which to create the local \n \t\tsnapshots.
\nTo create snapshots from an instance in a Region, omit this parameter. The \n \t\t\t\tsnapshots are created in the same Region as the instance.
\nTo create snapshots from an instance on an Outpost and store the snapshots \n \t\t\t\tin the Region, omit this parameter. The snapshots are created in the Region \n \t\t\t\tfor the Outpost.
\nTo create snapshots from an instance on an Outpost and store the snapshots \n \t\t\t\ton an Outpost, specify the ARN of the destination Outpost. The snapshots must \n \t\t\t\tbe created on the same Outpost as the instance.
\nFor more information, see \n \t\tCreate multi-volume local snapshots from instances on an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.
" } }, "TagSpecifications": { @@ -17697,7 +17688,7 @@ "target": "com.amazonaws.ec2#CreateSubnetResult" }, "traits": { - "smithy.api#documentation": "Creates a subnet in a specified VPC.
\nYou must specify an IPv4 CIDR block for the subnet. After you create a subnet, you\n can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP\n addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the\n CIDR block of an existing subnet in the VPC.
\nIf you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an\n IPv6 CIDR block that uses a /64 prefix length.
\nAmazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR\n block. They're not available for use.
\nIf you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.
\nWhen you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.
\nFor more information about subnets, see Your VPC and subnets in the\n Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates a subnet in a specified VPC.
\nYou must specify an IPv4 CIDR block for the subnet. After you create a subnet, you\n can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP\n addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the\n CIDR block of an existing subnet in the VPC.
\nIf you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an\n IPv6 CIDR block that uses a /64 prefix length.
\nAmazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR\n block. They're not available for use.
\nIf you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.
\nWhen you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.
\nFor more information about subnets, see Your VPC and subnets in the\n Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateSubnetCidrReservation": { @@ -17735,7 +17726,7 @@ "target": "com.amazonaws.ec2#SubnetCidrReservationType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of reservation.
\nThe following are valid values:
\n\n prefix: The Amazon EC2\n Prefix\n Delegation feature assigns the IP addresses to network interfaces that are\n associated with an instance. For information about Prefix\n Delegation,\n see Prefix Delegation\n for Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.
\n explicit: You manually assign the IP addresses to resources that\n reside in your subnet.
The type of reservation.
\nThe following are valid values:
\n\n prefix: The Amazon EC2\n Prefix\n Delegation feature assigns the IP addresses to network interfaces that are\n associated with an instance. For information about Prefix\n Delegation,\n see Prefix Delegation\n for Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.
\n explicit: You manually assign the IP addresses to resources that\n reside in your subnet.
The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.
\nThis parameter is required for an IPv6 only subnet.
" + "smithy.api#documentation": "The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.
\nThis parameter is required for an IPv6 only subnet.
" } }, "OutpostArn": { @@ -17865,7 +17856,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified Amazon EC2 resource or\n resources. When you specify an existing tag key, the value is overwritten with\n the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and\n optional value. Tag keys must be unique per resource.
\n \nFor more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide. For more information about\n creating IAM policies that control users' access to resources based on tags, see Supported\n resource-level permissions for Amazon EC2 API actions in the Amazon\n Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified Amazon EC2 resource or\n resources. When you specify an existing tag key, the value is overwritten with\n the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and\n optional value. Tag keys must be unique per resource.
\nFor more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide. For more information about\n creating IAM policies that control users' access to resources based on tags, see Supported\n resource-level permissions for Amazon EC2 API actions in the Amazon\n Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateTagsRequest": { @@ -17885,7 +17876,7 @@ "target": "com.amazonaws.ec2#ResourceIdList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the resources, separated by spaces.
\n \tConstraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
", + "smithy.api#documentation": "The IDs of the resources, separated by spaces.
\nConstraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
", "smithy.api#required": {}, "smithy.api#xmlName": "ResourceId" } @@ -18303,7 +18294,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayResult" }, "traits": { - "smithy.api#documentation": "Creates a transit gateway.
\nYou can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks.\n After the transit gateway enters the available state, you can attach your VPCs and VPN\n connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
\nTo attach a VPN connection, use CreateCustomerGateway to create a customer \n gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to\n CreateVpnConnection.
\nWhen you create a transit gateway, we create a default transit gateway route table and use it as the default association route table\n and the default propagation route table. You can use CreateTransitGatewayRouteTable to create\n additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. \n You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource \n attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
" + "smithy.api#documentation": "Creates a transit gateway.
\nYou can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks.\n After the transit gateway enters the available state, you can attach your VPCs and VPN\n connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
\nTo attach a VPN connection, use CreateCustomerGateway to create a customer \n gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to\n CreateVpnConnection.
\nWhen you create a transit gateway, we create a default transit gateway route table and use it as the default association route table\n and the default propagation route table. You can use CreateTransitGatewayRouteTable to create\n additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. \n You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource \n attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
" } }, "com.amazonaws.ec2#CreateTransitGatewayConnect": { @@ -18315,7 +18306,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayConnectResult" }, "traits": { - "smithy.api#documentation": "Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
\nA Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
" + "smithy.api#documentation": "Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
\nA Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
" } }, "com.amazonaws.ec2#CreateTransitGatewayConnectPeer": { @@ -18327,7 +18318,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeerResult" }, "traits": { - "smithy.api#documentation": "Creates a Connect peer for a specified transit gateway Connect attachment between a\n transit gateway and an appliance.
\nThe peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
\nFor more information, see Connect peers in the Transit Gateways Guide.
" + "smithy.api#documentation": "Creates a Connect peer for a specified transit gateway Connect attachment between a\n transit gateway and an appliance.
\nThe peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
\nFor more information, see Connect peers in the Transit Gateways Guide.
" } }, "com.amazonaws.ec2#CreateTransitGatewayConnectPeerRequest": { @@ -18473,7 +18464,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainResult" }, "traits": { - "smithy.api#documentation": "Creates a multicast domain using the specified transit gateway.
\nThe transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
" + "smithy.api#documentation": "Creates a multicast domain using the specified transit gateway.
\nThe transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
" } }, "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequest": { @@ -18558,7 +18549,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult" }, "traits": { - "smithy.api#documentation": "Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The peer transit gateway can be in \n your account or a different Amazon Web Services account.
\nAfter you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.
" + "smithy.api#documentation": "Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The peer transit gateway can be in \n your account or a different Amazon Web Services account.
\nAfter you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.
" } }, "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest": { @@ -19743,7 +19734,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
\nThis parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
" + "smithy.api#documentation": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
\nThis parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
" } }, "ClientToken": { @@ -19764,7 +19755,7 @@ "target": "com.amazonaws.ec2#CreateVpcResult" }, "traits": { - "smithy.api#documentation": "Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create\n\t\t\tuses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4\n\t\t\taddresses). For more information about how large to make your VPC, see Your VPC and\n\t\t\t\tsubnets in the Amazon Virtual Private Cloud User Guide.
\nYou can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided \n IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address \n pool that you provisioned through bring your own IP addresses (BYOIP).
\n\tBy default, each instance you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
\nYou can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create\n\t\t\tuses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4\n\t\t\taddresses). For more information about how large to make your VPC, see Your VPC and\n\t\t\t\tsubnets in the Amazon Virtual Private Cloud User Guide.
\nYou can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided \n IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address \n pool that you provisioned through bring your own IP addresses (BYOIP).
\nBy default, each instance you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
\nYou can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateVpcEndpoint": { @@ -19788,7 +19779,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationResult" }, "traits": { - "smithy.api#documentation": "Creates a connection notification for a specified VPC endpoint or VPC endpoint\n service. A connection notification notifies you of specific endpoint events. You must\n create an SNS topic to receive notifications. For more information, see Create a Topic in\n the Amazon Simple Notification Service Developer Guide.
\nYou can create a connection notification for interface endpoints only.
" + "smithy.api#documentation": "Creates a connection notification for a specified VPC endpoint or VPC endpoint\n service. A connection notification notifies you of specific endpoint events. You must\n create an SNS topic to receive notifications. For more information, see Create a Topic in\n the Amazon Simple Notification Service Developer Guide.
\nYou can create a connection notification for interface endpoints only.
" } }, "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest": { @@ -19873,7 +19864,7 @@ "VpcEndpointType": { "target": "com.amazonaws.ec2#VpcEndpointType", "traits": { - "smithy.api#documentation": "The type of endpoint.
\nDefault: Gateway
" + "smithy.api#documentation": "The type of endpoint.
\nDefault: Gateway
" } }, "VpcId": { @@ -19942,7 +19933,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.
Default: true\n
(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.
Default: true\n
Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,\n IAM users, and IAM roles) can connect.
\nBefore you create an endpoint service, you must create one of the following for your service:
\nA Network Load Balancer. \n Service consumers connect to your service using an interface endpoint.
\nA Gateway Load Balancer. \n Service consumers connect to your service using a Gateway Load Balancer endpoint.
\nIf you set the private DNS name, you must prove that you own the private DNS domain\n name.
\n\tFor more information, see the Amazon Web Services PrivateLink \n\t Guide.
" + "smithy.api#documentation": "Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,\n IAM users, and IAM roles) can connect.
\nBefore you create an endpoint service, you must create one of the following for your service:
\nA Network Load Balancer. \n Service consumers connect to your service using an interface endpoint.
\nA Gateway Load Balancer. \n Service consumers connect to your service using a Gateway Load Balancer endpoint.
\nIf you set the private DNS name, you must prove that you own the private DNS domain\n name.
\nFor more information, see the Amazon Web Services PrivateLink \n\t Guide.
" } }, "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest": { @@ -20127,7 +20118,7 @@ "PeerRegion": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.
\n\t\tDefault: The Region in which you make the request.
" + "smithy.api#documentation": "The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.
\nDefault: The Region in which you make the request.
" } }, "TagSpecifications": { @@ -20180,7 +20171,7 @@ "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
" + "smithy.api#documentation": "The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
" } }, "Ipv4IpamPoolId": { @@ -20262,7 +20253,7 @@ "target": "com.amazonaws.ec2#CreateVpnConnectionResult" }, "traits": { - "smithy.api#documentation": "Creates a VPN connection between an existing virtual private gateway or transit\n gateway and a customer gateway. The supported connection type is\n ipsec.1.
The response includes information that you need to give to your network administrator\n to configure your customer gateway.
\nWe strongly recommend that you use HTTPS when calling this operation because the\n response contains sensitive cryptographic information for configuring your customer\n gateway device.
\nIf you decide to shut down your VPN connection for any reason and later create a new\n VPN connection, you must reconfigure your customer gateway with the new information\n returned from this call.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon\n EC2 doesn't return an error.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" + "smithy.api#documentation": "Creates a VPN connection between an existing virtual private gateway or transit\n gateway and a customer gateway. The supported connection type is\n ipsec.1.
The response includes information that you need to give to your network administrator\n to configure your customer gateway.
\nWe strongly recommend that you use HTTPS when calling this operation because the\n response contains sensitive cryptographic information for configuring your customer\n gateway device.
\nIf you decide to shut down your VPN connection for any reason and later create a new\n VPN connection, you must reconfigure your customer gateway with the new information\n returned from this call.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon\n EC2 doesn't return an error.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" } }, "com.amazonaws.ec2#CreateVpnConnectionRequest": { @@ -20351,7 +20342,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Creates a static route associated with a VPN connection between an existing virtual\n private gateway and a VPN customer gateway. The static route allows traffic to be routed\n from the virtual private gateway to the VPN customer gateway.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" + "smithy.api#documentation": "Creates a static route associated with a VPN connection between an existing virtual\n private gateway and a VPN customer gateway. The static route allows traffic to be routed\n from the virtual private gateway to the VPN customer gateway.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" } }, "com.amazonaws.ec2#CreateVpnConnectionRouteRequest": { @@ -20387,7 +20378,7 @@ "target": "com.amazonaws.ec2#CreateVpnGatewayResult" }, "traits": { - "smithy.api#documentation": "Creates a virtual private gateway. A virtual private gateway is the endpoint on the\n VPC side of your VPN connection. You can create a virtual private gateway before\n creating the VPC itself.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" + "smithy.api#documentation": "Creates a virtual private gateway. A virtual private gateway is the endpoint on the\n VPC side of your VPN connection. You can create a virtual private gateway before\n creating the VPC itself.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" } }, "com.amazonaws.ec2#CreateVpnGatewayRequest": { @@ -20419,7 +20410,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If\n you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a\n 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
\nDefault: 64512
" + "smithy.api#documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If\n you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a\n 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
\nDefault: 64512
" } }, "DryRun": { @@ -20460,7 +20451,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "CpuCredits", - "smithy.api#documentation": "The credit option for CPU usage of a T instance.
\nValid values: standard | unlimited\n
The credit option for CPU usage of a T instance.
\nValid values: standard | unlimited\n
The credit option for CPU usage of a T instance.
\nValid values: standard | unlimited\n
The credit option for CPU usage of a T instance.
\nValid values: standard | unlimited\n
Metric data aggregations over specified periods of time. The following are the supported Infrastructure Performance statistics:
\n\n\n p50 - The median value of the metric aggregated over a specified\n start and end time. For example, a metric of five_minutes is the median\n of all the data points gathered within those five minutes.
Metric data aggregations over specified periods of time. The following are the supported Infrastructure Performance statistics:
\n\n p50 - The median value of the metric aggregated over a specified\n start and end time. For example, a metric of five_minutes is the median\n of all the data points gathered within those five minutes.
Deletes a carrier gateway.
\nIf you do not delete the route that contains the carrier gateway as the\n Target, the route is a blackhole route. For information about how to delete a route, see \n DeleteRoute.
\nDeletes a carrier gateway.
\nIf you do not delete the route that contains the carrier gateway as the\n Target, the route is a blackhole route. For information about how to delete a route, see \n DeleteRoute.
\nDeletes the specified EC2 Fleet.
\nAfter you delete an EC2 Fleet, it launches no new instances.
\nYou must specify whether a deleted EC2 Fleet should also terminate its instances. If you\n choose to terminate the instances, the EC2 Fleet enters the deleted_terminating\n state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances\n continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is\n deleted. A deleted instant fleet with running instances is not\n supported.
\n Restrictions\n
\nYou can delete up to 25 instant fleets in a single request. If you exceed this\n number, no instant fleets are deleted and an error is returned. There is no\n restriction on the number of fleets of type maintain or request that can be deleted\n in a single request.
Up to 1000 instances can be terminated in a single request to delete\n instant fleets.
For more information, see Delete an EC2\n Fleet in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Deletes the specified EC2 Fleet.
\nAfter you delete an EC2 Fleet, it launches no new instances.
\nYou must specify whether a deleted EC2 Fleet should also terminate its instances. If you\n choose to terminate the instances, the EC2 Fleet enters the deleted_terminating\n state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances\n continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is\n deleted. A deleted instant fleet with running instances is not\n supported.
\n Restrictions\n
\nYou can delete up to 25 instant fleets in a single request. If you exceed this\n number, no instant fleets are deleted and an error is returned. There is no\n restriction on the number of fleets of type maintain or request that can be deleted\n in a single request.
Up to 1000 instances can be terminated in a single request to delete\n instant fleets.
For more information, see Delete an EC2\n Fleet in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#DeleteFleetsRequest": { @@ -21416,7 +21407,7 @@ "target": "com.amazonaws.ec2#FlowLogIdList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "One or more flow log IDs.
\nConstraint: Maximum of 1000 flow log IDs.
", + "smithy.api#documentation": "One or more flow log IDs.
\nConstraint: Maximum of 1000 flow log IDs.
", "smithy.api#required": {}, "smithy.api#xmlName": "FlowLogId" } @@ -21787,13 +21778,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The name of the launch template.
\nYou must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The name of the launch template.
\nYou must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
Deletes a security group.
\nIf you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.
We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDeletes a security group.
\nIf you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.
We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nThe IDs of the resources, separated by spaces.
\n \tConstraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
", + "smithy.api#documentation": "The IDs of the resources, separated by spaces.
\nConstraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
", "smithy.api#required": {}, "smithy.api#xmlName": "resourceId" } @@ -23161,7 +23152,7 @@ "target": "com.amazonaws.ec2#TagList", "traits": { "aws.protocols#ec2QueryName": "Tag", - "smithy.api#documentation": "The tags to delete. Specify a tag key and an optional tag value to delete\n specific tags. If you specify a tag key without a tag value, we delete any tag with this\n key regardless of its value. If you specify a tag key with an empty string as the tag\n value, we delete the tag only if its value is an empty string.
\nIf you omit this parameter, we delete all user-defined tags for the specified\n resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:\n prefix).
Constraints: Up to 1000 tags.
", + "smithy.api#documentation": "The tags to delete. Specify a tag key and an optional tag value to delete\n specific tags. If you specify a tag key without a tag value, we delete any tag with this\n key regardless of its value. If you specify a tag key with an empty string as the tag\n value, we delete the tag only if its value is an empty string.
\nIf you omit this parameter, we delete all user-defined tags for the specified\n resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:\n prefix).
Constraints: Up to 1000 tags.
", "smithy.api#xmlName": "tag" } } @@ -24235,7 +24226,7 @@ "target": "com.amazonaws.ec2#DeleteVpcEndpointsResult" }, "traits": { - "smithy.api#documentation": "Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.
\nGateway endpoint,
\nGateway Load Balancer endpoint,
\nInterface endpoint
\nThe following rules apply when you delete a VPC endpoint:
\nWhen you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.
\nWhen you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.
\nYou can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
\nWhen you delete an interface endpoint, we delete the endpoint network interfaces.
\nDeletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.
\nGateway endpoint,
\nGateway Load Balancer endpoint,
\nInterface endpoint
\nThe following rules apply when you delete a VPC endpoint:
\nWhen you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.
\nWhen you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.
\nYou can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
\nWhen you delete an interface endpoint, we delete the endpoint network interfaces.
\nDeletes the specified VPN connection.
\nIf you're deleting the VPC and its associated components, we recommend that you detach\n the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n connection. If you believe that the tunnel credentials for your VPN connection have been\n compromised, you can delete the VPN connection and create a new one that has new keys,\n without needing to delete the VPC or virtual private gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway device using the new configuration\n information returned with the new VPN connection ID.
\nFor certificate-based authentication, delete all Certificate Manager (ACM) private\n certificates used for the Amazon Web Services-side tunnel endpoints for the VPN\n connection before deleting the VPN connection.
" + "smithy.api#documentation": "Deletes the specified VPN connection.
\nIf you're deleting the VPC and its associated components, we recommend that you detach\n the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n connection. If you believe that the tunnel credentials for your VPN connection have been\n compromised, you can delete the VPN connection and create a new one that has new keys,\n without needing to delete the VPC or virtual private gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway device using the new configuration\n information returned with the new VPN connection ID.
\nFor certificate-based authentication, delete all Certificate Manager (ACM) private\n certificates used for the Amazon Web Services-side tunnel endpoints for the VPN\n connection before deleting the VPN connection.
" } }, "com.amazonaws.ec2#DeleteVpnConnectionRequest": { @@ -24644,7 +24635,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.
\n \n \nIf you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained\n in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon Elastic Compute Cloud User Guide.
\n \nWhen you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.
\n \tWhen you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.
" + "smithy.api#documentation": "Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.
\nIf you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained\n in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon Elastic Compute Cloud User Guide.
\nWhen you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.
\nWhen you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.
" } }, "com.amazonaws.ec2#DeregisterImageRequest": { @@ -24861,7 +24852,7 @@ "target": "com.amazonaws.ec2#DescribeAccountAttributesResult" }, "traits": { - "smithy.api#documentation": "Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
\n\n supported-platforms: Indicates whether your account can launch instances\n into EC2-Classic and EC2-VPC, or only into EC2-VPC.
\n default-vpc: The ID of the default VPC for your account, or\n none.
\n max-instances: This attribute is no longer supported. The returned\n value does not reflect your actual vCPU limit for running On-Demand Instances.\n For more information, see On-Demand Instance Limits in the\n Amazon Elastic Compute Cloud User Guide.
\n vpc-max-security-groups-per-interface: The maximum number of security groups\n that you can assign to a network interface.
\n max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with EC2-Classic.
\n vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with EC2-VPC.
We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.
\nDescribes attributes of your Amazon Web Services account. The following are the supported account attributes:
\n\n supported-platforms: Indicates whether your account can launch instances\n into EC2-Classic and EC2-VPC, or only into EC2-VPC.
\n default-vpc: The ID of the default VPC for your account, or\n none.
\n max-instances: This attribute is no longer supported. The returned\n value does not reflect your actual vCPU limit for running On-Demand Instances.\n For more information, see On-Demand Instance Limits in the\n Amazon Elastic Compute Cloud User Guide.
\n vpc-max-security-groups-per-interface: The maximum number of security groups\n that you can assign to a network interface.
\n max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with EC2-Classic.
\n vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with EC2-VPC.
We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.
\nDescribes the longer ID format settings for all resource types in a specific\n Region. This request is useful for performing a quick audit to determine whether a\n specific Region is fully opted in for longer IDs (17-character IDs).
\n \nThis request only returns information about resource types that support longer IDs.
\nThe following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc |\n vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.
Describes the longer ID format settings for all resource types in a specific\n Region. This request is useful for performing a quick audit to determine whether a\n specific Region is fully opted in for longer IDs (17-character IDs).
\nThis request only returns information about resource types that support longer IDs.
\nThe following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc |\n vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.
One or more filters.
\n\t\t\n state - The state of the Fleet (submitted | modifying | active | \n\t\t\t\t\tpartially_fulfilled | expiring | expired | cancelling | \n\t\t\t\t\tcancelled | failed).
\n instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
\n tenancy - The tenancy of the Fleet (default | dedicated).
\n allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
One or more filters.
\n\n state - The state of the Fleet (submitted | modifying | active | \n\t\t\t\t\tpartially_fulfilled | expiring | expired | cancelling | \n\t\t\t\t\tcancelled | failed).
\n instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
\n tenancy - The tenancy of the Fleet (default | dedicated).
\n allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
One or more filters.
\n\t \t\n instance-type - The type of instance for which the Capacity Reservation reserves capacity.
\n owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
\n instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
\n availability-zone - The Availability Zone of the Capacity Reservation.
\n tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the \n\t \t\t\tfollowing tenancy settings:
\n default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
\n state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
\n active- The Capacity Reservation is active and the capacity is available for your use.
\n expired - The Capacity Reservation expired automatically at the date and time specified in your request. \n\t \t\t\t\tThe reserved capacity is no longer available for your use.
\n cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
\n pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
\n failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, \n\t \t\t\t\tcapacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
\n start-date - The date and time at which the Capacity Reservation was started.
\n end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is \n\t \t\t\treleased and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
\n end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
\n unlimited - The Capacity Reservation remains active until you explicitly cancel it.
\n limited - The Capacity Reservation expires automatically at a specified date and time.
\n instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
\n open - The Capacity Reservation accepts all instances that have matching\n\t\t\t\t\t\t\tattributes (instance type, platform, and Availability Zone). Instances\n\t\t\t\t\t\t\tthat have matching attributes launch into the Capacity Reservation\n\t\t\t\t\t\t\tautomatically without specifying any additional parameters.
\n targeted - The Capacity Reservation only accepts instances that have matching\n\t\t\t\t\t\t\tattributes (instance type, platform, and Availability Zone), and\n\t\t\t\t\t\t\texplicitly target the Capacity Reservation. This ensures that only\n\t\t\t\t\t\t\tpermitted instances can use the reserved capacity.
\n placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
One or more filters.
\n\n instance-type - The type of instance for which the Capacity Reservation reserves capacity.
\n owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
\n instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
\n availability-zone - The Availability Zone of the Capacity Reservation.
\n tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the \n\t \t\t\tfollowing tenancy settings:
\n default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
\n state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
\n active- The Capacity Reservation is active and the capacity is available for your use.
\n expired - The Capacity Reservation expired automatically at the date and time specified in your request. \n\t \t\t\t\tThe reserved capacity is no longer available for your use.
\n cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
\n pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
\n failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, \n\t \t\t\t\tcapacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
\n start-date - The date and time at which the Capacity Reservation was started.
\n end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is \n\t \t\t\treleased and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
\n end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
\n unlimited - The Capacity Reservation remains active until you explicitly cancel it.
\n limited - The Capacity Reservation expires automatically at a specified date and time.
\n instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
\n open - The Capacity Reservation accepts all instances that have matching\n\t\t\t\t\t\t\tattributes (instance type, platform, and Availability Zone). Instances\n\t\t\t\t\t\t\tthat have matching attributes launch into the Capacity Reservation\n\t\t\t\t\t\t\tautomatically without specifying any additional parameters.
\n targeted - The Capacity Reservation only accepts instances that have matching\n\t\t\t\t\t\t\tattributes (instance type, platform, and Availability Zone), and\n\t\t\t\t\t\t\texplicitly target the Capacity Reservation. This ensures that only\n\t\t\t\t\t\t\tpermitted instances can use the reserved capacity.
\n placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
One or more filters.
\n\n carrier-gateway-id - The ID of the carrier gateway.
\n state - The state of the carrier gateway (pending |\n failed | available | deleting | deleted).
\n owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC associated with the carrier gateway.
One or more filters.
\n\n carrier-gateway-id - The ID of the carrier gateway.
\n state - The state of the carrier gateway (pending |\n failed | available | deleting | deleted).
\n owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC associated with the carrier gateway.
Describes one or more of your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.
\n\tWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n\tDescribes one or more of your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nOne or more filters.
\n\t\t\n group-id - The ID of a VPC security group that's associated with the instance.
\n instance-id - The ID of the instance.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n\t\t\t\t\t vpc-id - The ID of the VPC to which the instance is\n\t\t\t\t\tlinked.
\n vpc-id - The ID of the VPC that the instance is linked to.
One or more filters.
\n\n group-id - The ID of a VPC security group that's associated with the instance.
\n instance-id - The ID of the instance.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC to which the instance is\n\t\t\t\t\tlinked.
\n vpc-id - The ID of the VPC that the instance is linked to.
The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
Constraint: If the value is greater than 1000, we return only 1000 items.
", + "smithy.api#documentation": "The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
Constraint: If the value is greater than 1000, we return only 1000 items.
", "smithy.api#xmlName": "maxResults" } }, @@ -25883,7 +25874,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. Filter names and values are case-sensitive.
\n\t\n description - The description of the authorization rule.
\n destination-cidr - The CIDR of the network to which the authorization rule\n applies.
\n group-id - The ID of the Active Directory group to which the authorization rule grants access.
One or more filters. Filter names and values are case-sensitive.
\n\n description - The description of the authorization rule.
\n destination-cidr - The CIDR of the network to which the authorization rule\n applies.
\n group-id - The ID of the Active Directory group to which the authorization rule grants access.
One or more filters. Filter names and values are case-sensitive.
\n\t\n connection-id - The ID of the connection.
\n username - For Active Directory client authentication, the user name of the\n client who established the client connection.
One or more filters. Filter names and values are case-sensitive.
\n\n connection-id - The ID of the connection.
\n username - For Active Directory client authentication, the user name of the\n client who established the client connection.
One or more filters. Filter names and values are case-sensitive.
\n\t\n endpoint-id - The ID of the Client VPN endpoint.
\n transport-protocol - The transport protocol (tcp |\n udp).
One or more filters. Filter names and values are case-sensitive.
\n\n endpoint-id - The ID of the Client VPN endpoint.
\n transport-protocol - The transport protocol (tcp |\n udp).
One or more filters. Filter names and values are case-sensitive.
\n\t\n destination-cidr - The CIDR of the route destination.
\n origin - How the route was associated with the Client VPN endpoint (associate | add-route).
\n target-subnet - The ID of the subnet through which traffic is routed.
One or more filters. Filter names and values are case-sensitive.
\n\n destination-cidr - The CIDR of the route destination.
\n origin - How the route was associated with the Client VPN endpoint (associate | add-route).
\n target-subnet - The ID of the subnet through which traffic is routed.
One or more filters. Filter names and values are case-sensitive.
\n\t\n association-id - The ID of the association.
\n target-network-id - The ID of the subnet specified as the target network.
\n vpc-id - The ID of the VPC in which the target network is located.
One or more filters. Filter names and values are case-sensitive.
\n\n association-id - The ID of the association.
\n target-network-id - The ID of the subnet specified as the target network.
\n vpc-id - The ID of the VPC in which the target network is located.
Describes one or more of your VPN customer gateways.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
", + "smithy.api#documentation": "Describes one or more of your VPN customer gateways.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
", "smithy.waiters#waitable": { "CustomerGatewayAvailable": { "acceptors": [ @@ -26546,14 +26537,14 @@ "CustomerGatewayIds": { "target": "com.amazonaws.ec2#CustomerGatewayIdStringList", "traits": { - "smithy.api#documentation": "One or more customer gateway IDs.
\nDefault: Describes all your customer gateways.
", + "smithy.api#documentation": "One or more customer gateway IDs.
\nDefault: Describes all your customer gateways.
", "smithy.api#xmlName": "CustomerGatewayId" } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n bgp-asn - The customer gateway's Border Gateway Protocol (BGP)\n Autonomous System Number (ASN).
\n customer-gateway-id - The ID of the customer gateway.
\n ip-address - The IP address of the customer gateway\n device's external interface.
\n state - The state of the customer gateway (pending |\n available | deleting |\n deleted).
\n type - The type of customer gateway. Currently, the only\n supported type is ipsec.1.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n bgp-asn - The customer gateway's Border Gateway Protocol (BGP)\n Autonomous System Number (ASN).
\n customer-gateway-id - The ID of the customer gateway.
\n ip-address - The IP address of the customer gateway\n device's external interface.
\n state - The state of the customer gateway (pending |\n available | deleting |\n deleted).
\n type - The type of customer gateway. Currently, the only\n supported type is ipsec.1.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes one or more of your DHCP options sets.
\n\t\tFor more information, see DHCP options sets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
", + "smithy.api#documentation": "Describes one or more of your DHCP options sets.
\nFor more information, see DHCP options sets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -26622,14 +26613,14 @@ "DhcpOptionsIds": { "target": "com.amazonaws.ec2#DhcpOptionsIdStringList", "traits": { - "smithy.api#documentation": "The IDs of one or more DHCP options sets.
\n\t\tDefault: Describes all your DHCP options sets.
", + "smithy.api#documentation": "The IDs of one or more DHCP options sets.
\nDefault: Describes all your DHCP options sets.
", "smithy.api#xmlName": "DhcpOptionsId" } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\t\t\n dhcp-options-id - The ID of a DHCP options set.
\n key - The key for one of the options (for example, domain-name).
\n value - The value for one of the options.
\n owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n dhcp-options-id - The ID of a DHCP options set.
\n key - The key for one of the options (for example, domain-name).
\n value - The value for one of the options.
\n owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n \t\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
\n\n availability-zone - The Availability Zone in which the\n Elastic Graphics accelerator resides.
\n elastic-gpu-health - The status of the Elastic Graphics accelerator\n (OK | IMPAIRED).
\n elastic-gpu-state - The state of the Elastic Graphics accelerator\n (ATTACHED).
\n elastic-gpu-type - The type of Elastic Graphics accelerator; for example,\n eg1.medium.
\n instance-id - The ID of the instance to which the\n Elastic Graphics accelerator is associated.
The filters.
\n\n availability-zone - The Availability Zone in which the\n Elastic Graphics accelerator resides.
\n elastic-gpu-health - The status of the Elastic Graphics accelerator\n (OK | IMPAIRED).
\n elastic-gpu-state - The state of the Elastic Graphics accelerator\n (ATTACHED).
\n elastic-gpu-type - The type of Elastic Graphics accelerator; for example,\n eg1.medium.
\n instance-id - The ID of the instance to which the\n Elastic Graphics accelerator is associated.
Use the following filters to streamline results.
\n\t\t\n resource-type - The resource type for pre-provisioning.
\n launch-template - The launch template that is associated with the pre-provisioned Windows AMI.
\n owner-id - The owner ID for the pre-provisioning resource.
\n state - The current state of fast launching for the Windows AMI.
Use the following filters to streamline results.
\n\n resource-type - The resource type for pre-provisioning.
\n launch-template - The launch template that is associated with the pre-provisioned Windows AMI.
\n owner-id - The owner ID for the pre-provisioning resource.
\n state - The current state of fast launching for the Windows AMI.
Describes one or more flow logs.
\nTo view the published flow log records, you must view the log destination. For example, \n the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.
", + "smithy.api#documentation": "Describes one or more flow logs.
\nTo view the published flow log records, you must view the log destination. For example, \n the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -27801,13 +27792,13 @@ "Filter": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n deliver-log-status - The status of the logs delivery (SUCCESS |\n FAILED).
\n log-destination-type - The type of destination for the flow log\n data (cloud-watch-logs | s3 |\n kinesis-data-firehose).
\n flow-log-id - The ID of the flow log.
\n log-group-name - The name of the log group.
\n resource-id - The ID of the VPC, subnet, or network interface.
\n traffic-type - The type of traffic (ACCEPT |\n REJECT | ALL).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n deliver-log-status - The status of the logs delivery (SUCCESS |\n FAILED).
\n log-destination-type - The type of destination for the flow log\n data (cloud-watch-logs | s3 |\n kinesis-data-firehose).
\n flow-log-id - The ID of the flow log.
\n log-group-name - The name of the log group.
\n resource-id - The ID of the VPC, subnet, or network interface.
\n traffic-type - The type of traffic (ACCEPT |\n REJECT | ALL).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more flow log IDs.
\nConstraint: Maximum of 1000 flow log IDs.
", + "smithy.api#documentation": "One or more flow log IDs.
\nConstraint: Maximum of 1000 flow log IDs.
", "smithy.api#xmlName": "FlowLogId" } }, @@ -27958,7 +27949,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\t\t\n create-time - The creation time of the AFI.
\n fpga-image-id - The FPGA image identifier (AFI ID).
\n fpga-image-global-id - The global FPGA image identifier (AGFI ID).
\n name - The name of the AFI.
\n owner-id - The Amazon Web Services account ID of the AFI owner.
\n product-code - The product code.
\n shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
\n state - The state of the AFI (pending | failed | available | unavailable).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n update-time - The time of the most recent update.
The filters.
\n\n create-time - The creation time of the AFI.
\n fpga-image-id - The FPGA image identifier (AFI ID).
\n fpga-image-global-id - The global FPGA image identifier (AGFI ID).
\n name - The name of the AFI.
\n owner-id - The Amazon Web Services account ID of the AFI owner.
\n product-code - The product code.
\n shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
\n state - The state of the AFI (pending | failed | available | unavailable).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n update-time - The time of the most recent update.
Describes the Dedicated Host reservations that are available to purchase.
\nThe results describe all of the Dedicated Host reservation offerings, including\n offerings that might not match the instance family and Region of your Dedicated Hosts.\n When purchasing an offering, ensure that the instance family and Region of the offering\n matches that of the Dedicated Hosts with which it is to be associated. For more\n information about supported instance types, see Dedicated Hosts\n in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Describes the Dedicated Host reservations that are available to purchase.
\nThe results describe all of the Dedicated Host reservation offerings, including\n offerings that might not match the instance family and Region of your Dedicated Hosts.\n When purchasing an offering, ensure that the instance family and Region of the offering\n matches that of the Dedicated Hosts with which it is to be associated. For more\n information about supported instance types, see Dedicated Hosts\n in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -28023,7 +28014,7 @@ "Filter": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\n instance-family - The instance family of the offering (for example,\n m4).
\n payment-option - The payment option (NoUpfront |\n PartialUpfront | AllUpfront).
The filters.
\n\n instance-family - The instance family of the offering (for example,\n m4).
\n payment-option - The payment option (NoUpfront |\n PartialUpfront | AllUpfront).
The filters.
\n\n instance-family - The instance family (for example,\n m4).
\n payment-option - The payment option (NoUpfront |\n PartialUpfront | AllUpfront).
\n state - The state of the reservation (payment-pending\n | payment-failed | active |\n retired).
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
\n\n instance-family - The instance family (for example,\n m4).
\n payment-option - The payment option (NoUpfront |\n PartialUpfront | AllUpfront).
\n state - The state of the reservation (payment-pending\n | payment-failed | active |\n retired).
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes the specified Dedicated Hosts or all your Dedicated Hosts.
\nThe results describe only the Dedicated Hosts in the Region you're currently using.\n All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have\n recently been released are listed with the state released.
Describes the specified Dedicated Hosts or all your Dedicated Hosts.
\nThe results describe only the Dedicated Hosts in the Region you're currently using.\n All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have\n recently been released are listed with the state released.
The filters.
\n\n auto-placement - Whether auto-placement is enabled or disabled\n (on | off).
\n availability-zone - The Availability Zone of the host.
\n client-token - The idempotency token that you provided when you\n allocated the host.
\n host-reservation-id - The ID of the reservation assigned to this\n host.
\n instance-type - The instance type size that the Dedicated Host is\n configured to support.
\n state - The allocation state of the Dedicated Host\n (available | under-assessment |\n permanent-failure | released |\n released-permanent-failure).
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
\n\n auto-placement - Whether auto-placement is enabled or disabled\n (on | off).
\n availability-zone - The Availability Zone of the host.
\n client-token - The idempotency token that you provided when you\n allocated the host.
\n host-reservation-id - The ID of the reservation assigned to this\n host.
\n instance-type - The instance type size that the Dedicated Host is\n configured to support.
\n state - The allocation state of the Dedicated Host\n (available | under-assessment |\n permanent-failure | released |\n released-permanent-failure).
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same\n request.
", + "smithy.api#documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same\n request.
", "smithy.api#xmlName": "maxResults" } }, @@ -28284,7 +28275,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\n instance-id - The ID of the instance.
\n state - The state of the association (associating |\n associated | disassociating).
The filters.
\n\n instance-id - The ID of the instance.
\n state - The state of the association (associating |\n associated | disassociating).
The AMI attribute.
\n \t\n Note: The blockDeviceMapping attribute is deprecated. \n \t Using this attribute returns the Client.AuthFailure error. To get information about \n \t the block device mappings for an AMI, use the DescribeImages action.
The AMI attribute.
\n\n Note: The blockDeviceMapping attribute is deprecated. \n \t Using this attribute returns the Client.AuthFailure error. To get information about \n \t the block device mappings for an AMI, use the DescribeImages action.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
\nThe images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.
\nRecently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.
", + "smithy.api#documentation": "Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
\nThe images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.
\nRecently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.
", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -28531,7 +28522,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\n architecture - The image architecture (i386 |\n x86_64 | arm64).
\n block-device-mapping.delete-on-termination - A Boolean value that indicates\n \twhether the Amazon EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in the block device mapping (for\n example, /dev/sdh or xvdh).
\n \t block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS\n volume.
\n \t block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
\n block-device-mapping.volume-type - The volume type of the Amazon EBS volume\n (io1 | io2 | gp2 | gp3 | sc1\n | st1 | standard).
\n \t\t\t block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
\n creation-date - The time when the image was created, in the ISO 8601\n format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for\n example, 2021-09-29T*, which matches an entire day.
\n description - The description of the image (provided during image\n creation).
\n ena-support - A Boolean that indicates whether enhanced networking\n with ENA is enabled.
\n hypervisor - The hypervisor type (ovm |\n xen).
\n image-id - The ID of the image.
\n image-type - The image type (machine | kernel |\n ramdisk).
\n is-public - A Boolean that indicates whether the image is public.
\n kernel-id - The kernel ID.
\n manifest-location - The location of the image manifest.
\n name - The name of the AMI (provided during image creation).
\n owner-alias - The owner alias (amazon | aws-marketplace). \n The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be \n \tset using the IAM console. We recommend that you use the Owner \n \trequest parameter instead of this filter.
\n owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the \n \t\tOwner request parameter instead of this filter.
\n platform - The platform. The only supported value is windows.
\n product-code - The product code.
\n product-code.type - The type of the product code (marketplace).
\n ramdisk-id - The RAM disk ID.
\n root-device-name - The device name of the root device volume (for example, /dev/sda1).
\n root-device-type - The type of the root device volume (ebs |\n instance-store).
\n state - The state of the image (available | pending\n | failed).
\n state-reason-code - The reason code for the state change.
\n state-reason-message - The message for the state change.
\n sriov-net-support - A value of simple indicates\n that enhanced networking with the Intel 82599 VF interface is enabled.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n virtualization-type - The virtualization type (paravirtual |\n hvm).
The filters.
\n\n architecture - The image architecture (i386 |\n x86_64 | arm64).
\n block-device-mapping.delete-on-termination - A Boolean value that indicates\n \twhether the Amazon EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in the block device mapping (for\n example, /dev/sdh or xvdh).
\n block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS\n volume.
\n block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
\n block-device-mapping.volume-type - The volume type of the Amazon EBS volume\n (io1 | io2 | gp2 | gp3 | sc1\n | st1 | standard).
\n block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
\n creation-date - The time when the image was created, in the ISO 8601\n format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for\n example, 2021-09-29T*, which matches an entire day.
\n description - The description of the image (provided during image\n creation).
\n ena-support - A Boolean that indicates whether enhanced networking\n with ENA is enabled.
\n hypervisor - The hypervisor type (ovm |\n xen).
\n image-id - The ID of the image.
\n image-type - The image type (machine | kernel |\n ramdisk).
\n is-public - A Boolean that indicates whether the image is public.
\n kernel-id - The kernel ID.
\n manifest-location - The location of the image manifest.
\n name - The name of the AMI (provided during image creation).
\n owner-alias - The owner alias (amazon | aws-marketplace). \n The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be \n \tset using the IAM console. We recommend that you use the Owner \n \trequest parameter instead of this filter.
\n owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the \n \t\tOwner request parameter instead of this filter.
\n platform - The platform. The only supported value is windows.
\n product-code - The product code.
\n product-code.type - The type of the product code (marketplace).
\n ramdisk-id - The RAM disk ID.
\n root-device-name - The device name of the root device volume (for example, /dev/sda1).
\n root-device-type - The type of the root device volume (ebs |\n instance-store).
\n state - The state of the image (available | pending\n | failed).
\n state-reason-code - The reason code for the state change.
\n state-reason-message - The message for the state change.
\n sriov-net-support - A value of simple indicates\n that enhanced networking with the Intel 82599 VF interface is enabled.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n virtualization-type - The virtualization type (paravirtual |\n hvm).
Describes the specified attribute of the specified instance. You can specify only one\n attribute at a time. Valid attribute values are: instanceType |\n kernel | ramdisk | userData |\n disableApiTermination | instanceInitiatedShutdownBehavior\n | rootDeviceName | blockDeviceMapping |\n productCodes | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport\n
Describes the specified attribute of the specified instance. You can specify only one\n attribute at a time. Valid attribute values are: instanceType |\n kernel | ramdisk | userData |\n disableApiTermination | instanceInitiatedShutdownBehavior\n | rootDeviceName | blockDeviceMapping |\n productCodes | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport\n
The instance attribute.
\nNote: The enaSupport attribute is not supported at this time.
The instance attribute.
\nNote: The enaSupport attribute is not supported at this time.
Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.
\nFor more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.
\nFor more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -28831,14 +28822,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\n instance-id - The ID of the instance.
The filters.
\n\n instance-id - The ID of the instance.
The instance IDs.
\nDefault: Describes all your instances.
\nConstraints: Maximum 1000 explicitly specified instance IDs.
", + "smithy.api#documentation": "The instance IDs.
\nDefault: Describes all your instances.
\nConstraints: Maximum 1000 explicitly specified instance IDs.
", "smithy.api#xmlName": "InstanceId" } }, @@ -29009,7 +29000,7 @@ "target": "com.amazonaws.ec2#DescribeInstanceStatusResult" }, "traits": { - "smithy.api#documentation": "Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.
\nInstance status includes the following components:
\n\n Status checks - Amazon EC2 performs status\n checks on running EC2 instances to identify hardware and software issues. For\n more information, see Status checks for your instances and Troubleshoot\n instances with failed status checks in the Amazon EC2 User\n Guide.
\n\n Scheduled events - Amazon EC2 can schedule\n events (such as reboot, stop, or terminate) for your instances related to\n hardware issues, software updates, or system maintenance. For more information,\n see Scheduled events for your instances in the Amazon EC2 User\n Guide.
\n\n Instance state - You can manage your instances\n from the moment you launch them through their termination. For more information,\n see Instance\n lifecycle in the Amazon EC2 User Guide.
\nDescribes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.
\nInstance status includes the following components:
\n\n Status checks - Amazon EC2 performs status\n checks on running EC2 instances to identify hardware and software issues. For\n more information, see Status checks for your instances and Troubleshoot\n instances with failed status checks in the Amazon EC2 User\n Guide.
\n\n Scheduled events - Amazon EC2 can schedule\n events (such as reboot, stop, or terminate) for your instances related to\n hardware issues, software updates, or system maintenance. For more information,\n see Scheduled events for your instances in the Amazon EC2 User\n Guide.
\n\n Instance state - You can manage your instances\n from the moment you launch them through their termination. For more information,\n see Instance\n lifecycle in the Amazon EC2 User Guide.
\nThe filters.
\n\n availability-zone - The Availability Zone of the instance.
\n event.code - The code for the scheduled event\n (instance-reboot | system-reboot |\n system-maintenance | instance-retirement |\n instance-stop).
\n event.description - A description of the event.
\n event.instance-event-id - The ID of the event whose date and time\n you are modifying.
\n event.not-after - The latest end time for the scheduled event\n (for example, 2014-09-15T17:15:20.000Z).
\n event.not-before - The earliest start time for the scheduled\n event (for example, 2014-09-15T17:15:20.000Z).
\n event.not-before-deadline - The deadline for starting the event\n (for example, 2014-09-15T17:15:20.000Z).
\n instance-state-code - The code for the instance state, as a\n 16-bit unsigned integer. The high byte is used for internal purposes and should\n be ignored. The low byte is set based on the state represented. The valid values\n are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).
\n instance-status.reachability - Filters on instance status where\n the name is reachability (passed | failed\n | initializing | insufficient-data).
\n instance-status.status - The status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).
\n system-status.reachability - Filters on system status where the\n name is reachability (passed | failed |\n initializing | insufficient-data).
\n system-status.status - The system status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).
The filters.
\n\n availability-zone - The Availability Zone of the instance.
\n event.code - The code for the scheduled event\n (instance-reboot | system-reboot |\n system-maintenance | instance-retirement |\n instance-stop).
\n event.description - A description of the event.
\n event.instance-event-id - The ID of the event whose date and time\n you are modifying.
\n event.not-after - The latest end time for the scheduled event\n (for example, 2014-09-15T17:15:20.000Z).
\n event.not-before - The earliest start time for the scheduled\n event (for example, 2014-09-15T17:15:20.000Z).
\n event.not-before-deadline - The deadline for starting the event\n (for example, 2014-09-15T17:15:20.000Z).
\n instance-state-code - The code for the instance state, as a\n 16-bit unsigned integer. The high byte is used for internal purposes and should\n be ignored. The low byte is set based on the state represented. The valid values\n are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).
\n instance-status.reachability - Filters on instance status where\n the name is reachability (passed | failed\n | initializing | insufficient-data).
\n instance-status.status - The status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).
\n system-status.reachability - Filters on system status where the\n name is reachability (passed | failed |\n initializing | insufficient-data).
\n system-status.status - The system status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).
The instance IDs.
\nDefault: Describes all your instances.
\nConstraints: Maximum 100 explicitly specified instance IDs.
", + "smithy.api#documentation": "The instance IDs.
\nDefault: Describes all your instances.
\nConstraints: Maximum 100 explicitly specified instance IDs.
", "smithy.api#xmlName": "InstanceId" } }, @@ -29106,7 +29097,7 @@ "aws.protocols#ec2QueryName": "IncludeAllInstances", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "When true, includes the health status for all instances. When\n false, includes the health status for running instances only.
Default: false\n
When true, includes the health status for all instances. When\n false, includes the health status for running instances only.
Default: false\n
Describes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
", + "smithy.api#documentation": "Describes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -29459,14 +29450,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).
\n architecture - The instance architecture (i386 |\n x86_64 | arm64).
\n availability-zone - The Availability Zone of the instance.
\n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2010-09-15T17:15:20.000Z.
\n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in the\n block device mapping (for example, /dev/sdh or\n xvdh).
\n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).
\n block-device-mapping.volume-id - The volume ID of the EBS\n volume.
\n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.
\n client-token - The idempotency token you provided when you launched\n the instance.
\n dns-name - The public DNS name of the instance.
\n group-id - The ID of the security group for the instance.\n EC2-Classic only.
\n group-name - The name of the security group for the instance.\n EC2-Classic only.
\n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.
\n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.
\n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.
\n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.
\n image-id - The ID of the image used to launch the\n instance.
\n instance-id - The ID of the instance.
\n instance-lifecycle - Indicates whether this is a Spot Instance or\n a Scheduled Instance (spot | scheduled).
\n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).
\n instance-type - The type of instance (for example,\n t2.micro).
\n instance.group-id - The ID of the security group for the\n instance.
\n instance.group-name - The name of the security group for the\n instance.
\n ip-address - The public IPv4 address of the instance.
\n kernel-id - The kernel ID.
\n key-name - The name of the key pair used when the instance was\n launched.
\n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n
\n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.
\n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)
\n metadata-options.http-put-response-hop-limit - The http metadata\n request put response hop limit (integer, possible values 1 to\n 64)
\n metadata-options.http-endpoint - Enable or disable metadata\n access on http endpoint (enabled | disabled)
\n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).
\n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.
\n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.
\n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.
\n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.
\n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.
\n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.
\n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.
\n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.
\n network-interface.attachment.attachment-id - The ID of the\n interface attachment.
\n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.
\n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.
\n network-interface.attachment.device-index - The device index to\n which the network interface is attached.
\n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).
\n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.
\n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.
\n network-interface.availability-zone - The Availability Zone for\n the network interface.
\n network-interface.description - The description of the network\n interface.
\n network-interface.group-id - The ID of a security group\n associated with the network interface.
\n network-interface.group-name - The name of a security group\n associated with the network interface.
\n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.
\n network-interface.mac-address - The MAC address of the network\n interface.
\n network-interface.network-interface-id - The ID of the network\n interface.
\n network-interface.owner-id - The ID of the owner of the network\n interface.
\n network-interface.private-dns-name - The private DNS name of the\n network interface.
\n network-interface.requester-id - The requester ID for the network\n interface.
\n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.
\n network-interface.status - The status of the network interface\n (available) | in-use).
\n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.
\n network-interface.subnet-id - The ID of the subnet for the\n network interface.
\n network-interface.vpc-id - The ID of the VPC for the network\n interface.
\n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.
\n owner-id - The Amazon Web Services account ID of the instance\n owner.
\n placement-group-name - The name of the placement group for the\n instance.
\n placement-partition-number - The partition in which the instance is\n located.
\n platform - The platform. To list only Windows instances, use\n windows.
\n private-dns-name - The private IPv4 DNS name of the\n instance.
\n private-ip-address - The private IPv4 address of the\n instance.
\n product-code - The product code associated with the AMI used to\n launch the instance.
\n product-code.type - The type of product code (devpay |\n marketplace).
\n ramdisk-id - The RAM disk ID.
\n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.
\n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).
\n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.
\n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).
\n root-device-type - The type of the root device volume\n (ebs | instance-store).
\n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.
\n spot-instance-request-id - The ID of the Spot Instance\n request.
\n state-reason-code - The reason code for the state change.
\n state-reason-message - A message that describes the state\n change.
\n subnet-id - The ID of the subnet for the instance.
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
\n tenancy - The tenancy of an instance (dedicated |\n default | host).
\n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).
\n vpc-id - The ID of the VPC that the instance is running in.
The filters.
\n\n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).
\n architecture - The instance architecture (i386 |\n x86_64 | arm64).
\n availability-zone - The Availability Zone of the instance.
\n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2010-09-15T17:15:20.000Z.
\n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in the\n block device mapping (for example, /dev/sdh or\n xvdh).
\n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).
\n block-device-mapping.volume-id - The volume ID of the EBS\n volume.
\n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.
\n client-token - The idempotency token you provided when you launched\n the instance.
\n dns-name - The public DNS name of the instance.
\n group-id - The ID of the security group for the instance.\n EC2-Classic only.
\n group-name - The name of the security group for the instance.\n EC2-Classic only.
\n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.
\n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.
\n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.
\n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.
\n image-id - The ID of the image used to launch the\n instance.
\n instance-id - The ID of the instance.
\n instance-lifecycle - Indicates whether this is a Spot Instance or\n a Scheduled Instance (spot | scheduled).
\n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).
\n instance-type - The type of instance (for example,\n t2.micro).
\n instance.group-id - The ID of the security group for the\n instance.
\n instance.group-name - The name of the security group for the\n instance.
\n ip-address - The public IPv4 address of the instance.
\n kernel-id - The kernel ID.
\n key-name - The name of the key pair used when the instance was\n launched.
\n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n
\n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.
\n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)
\n metadata-options.http-put-response-hop-limit - The http metadata\n request put response hop limit (integer, possible values 1 to\n 64)
\n metadata-options.http-endpoint - Enable or disable metadata\n access on http endpoint (enabled | disabled)
\n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).
\n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.
\n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.
\n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.
\n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.
\n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.
\n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.
\n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.
\n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.
\n network-interface.attachment.attachment-id - The ID of the\n interface attachment.
\n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.
\n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.
\n network-interface.attachment.device-index - The device index to\n which the network interface is attached.
\n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).
\n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.
\n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.
\n network-interface.availability-zone - The Availability Zone for\n the network interface.
\n network-interface.description - The description of the network\n interface.
\n network-interface.group-id - The ID of a security group\n associated with the network interface.
\n network-interface.group-name - The name of a security group\n associated with the network interface.
\n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.
\n network-interface.mac-address - The MAC address of the network\n interface.
\n network-interface.network-interface-id - The ID of the network\n interface.
\n network-interface.owner-id - The ID of the owner of the network\n interface.
\n network-interface.private-dns-name - The private DNS name of the\n network interface.
\n network-interface.requester-id - The requester ID for the network\n interface.
\n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.
\n network-interface.status - The status of the network interface\n (available) | in-use).
\n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.
\n network-interface.subnet-id - The ID of the subnet for the\n network interface.
\n network-interface.vpc-id - The ID of the VPC for the network\n interface.
\n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.
\n owner-id - The Amazon Web Services account ID of the instance\n owner.
\n placement-group-name - The name of the placement group for the\n instance.
\n placement-partition-number - The partition in which the instance is\n located.
\n platform - The platform. To list only Windows instances, use\n windows.
\n private-dns-name - The private IPv4 DNS name of the\n instance.
\n private-ip-address - The private IPv4 address of the\n instance.
\n product-code - The product code associated with the AMI used to\n launch the instance.
\n product-code.type - The type of product code (devpay |\n marketplace).
\n ramdisk-id - The RAM disk ID.
\n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.
\n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).
\n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.
\n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).
\n root-device-type - The type of the root device volume\n (ebs | instance-store).
\n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.
\n spot-instance-request-id - The ID of the Spot Instance\n request.
\n state-reason-code - The reason code for the state change.
\n state-reason-message - A message that describes the state\n change.
\n subnet-id - The ID of the subnet for the instance.
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
\n tenancy - The tenancy of an instance (dedicated |\n default | host).
\n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).
\n vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
\nDefault: Describes all your instances.
", + "smithy.api#documentation": "The instance IDs.
\nDefault: Describes all your instances.
", "smithy.api#xmlName": "InstanceId" } }, @@ -29581,7 +29572,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n attachment.state - The current state of the attachment between the gateway\n and the VPC (available). Present only if a VPC is attached.
\n attachment.vpc-id - The ID of an attached VPC.
\n internet-gateway-id - The ID of the Internet gateway.
\n owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n attachment.state - The current state of the attachment between the gateway\n and the VPC (available). Present only if a VPC is attached.
\n attachment.vpc-id - The ID of an attached VPC.
\n internet-gateway-id - The ID of the Internet gateway.
\n owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more internet gateway IDs.
\nDefault: Describes all your internet gateways.
", + "smithy.api#documentation": "One or more internet gateway IDs.
\nDefault: Describes all your internet gateways.
", "smithy.api#xmlName": "internetGatewayId" } }, @@ -29933,7 +29924,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
\n\n \t\t\t key-pair-id - The ID of the key pair.
\n fingerprint - The fingerprint of the key pair.
\n key-name - The name of the key pair.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The filters.
\n\n key-pair-id - The ID of the key pair.
\n fingerprint - The fingerprint of the key pair.
\n key-name - The name of the key pair.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
If true, the public key material is included in the response.
Default: false\n
If true, the public key material is included in the response.
Default: false\n
The ID of the launch template.
\nTo describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateId or the LaunchTemplateName, but not\n both.
To describe all the latest or default launch template versions in your account, you\n must omit this parameter.
" + "smithy.api#documentation": "The ID of the launch template.
\nTo describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateId or the LaunchTemplateName, but not\n both.
To describe all the latest or default launch template versions in your account, you\n must omit this parameter.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nTo describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateName or the LaunchTemplateId, but not\n both.
To describe all the latest or default launch template versions in your account, you\n must omit this parameter.
" + "smithy.api#documentation": "The name of the launch template.
\nTo describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateName or the LaunchTemplateId, but not\n both.
To describe all the latest or default launch template versions in your account, you\n must omit this parameter.
" } }, "Versions": { "target": "com.amazonaws.ec2#VersionStringList", "traits": { - "smithy.api#documentation": "One or more versions of the launch template. Valid values depend on whether you are\n describing a specified launch template (by ID or name) or all launch templates in your\n account.
\nTo describe one or more versions of a specified launch template, valid values are\n $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest\n version, the valid value is $Latest. To describe all launch templates in\n your account that are defined as the default version, the valid value is\n $Default. You can specify $Latest and\n $Default in the same request. You cannot specify numbers.
One or more versions of the launch template. Valid values depend on whether you are\n describing a specified launch template (by ID or name) or all launch templates in your\n account.
\nTo describe one or more versions of a specified launch template, valid values are\n $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest\n version, the valid value is $Latest. To describe all launch templates in\n your account that are defined as the default version, the valid value is\n $Default. You can specify $Latest and\n $Default in the same request. You cannot specify numbers.
One or more filters.
\n\n create-time - The time the launch template version was\n created.
\n ebs-optimized - A boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.
\n http-endpoint - Indicates whether the HTTP metadata endpoint on\n your instances is enabled (enabled | disabled).
\n http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the\n instance metadata service is enabled (enabled |\n disabled).
\n host-resource-group-arn - The ARN of the host resource group in\n which to launch the instances.
\n http-tokens - The state of token usage for your instance metadata\n requests (optional | required).
\n iam-instance-profile - The ARN of the IAM instance\n profile.
\n image-id - The ID of the AMI.
\n instance-type - The instance type.
\n is-default-version - A boolean that indicates whether the launch\n template version is the default version.
\n kernel-id - The kernel ID.
\n license-configuration-arn - The ARN of the license\n configuration.
\n network-card-index - The index of the network card.
\n ram-disk-id - The RAM disk ID.
One or more filters.
\n\n create-time - The time the launch template version was\n created.
\n ebs-optimized - A boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.
\n http-endpoint - Indicates whether the HTTP metadata endpoint on\n your instances is enabled (enabled | disabled).
\n http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the\n instance metadata service is enabled (enabled |\n disabled).
\n host-resource-group-arn - The ARN of the host resource group in\n which to launch the instances.
\n http-tokens - The state of token usage for your instance metadata\n requests (optional | required).
\n iam-instance-profile - The ARN of the IAM instance\n profile.
\n image-id - The ID of the AMI.
\n instance-type - The instance type.
\n is-default-version - A boolean that indicates whether the launch\n template version is the default version.
\n kernel-id - The kernel ID.
\n license-configuration-arn - The ARN of the license\n configuration.
\n network-card-index - The index of the network card.
\n ram-disk-id - The RAM disk ID.
One or more filters.
\n\n create-time - The time the launch template was created.
\n launch-template-name - The name of the launch template.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n create-time - The time the launch template was created.
\n launch-template-name - The name of the launch template.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
\nTo view the entries for your prefix list, use GetManagedPrefixListEntries.
", + "smithy.api#documentation": "Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
\nTo view the entries for your prefix list, use GetManagedPrefixListEntries.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -30768,7 +30759,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n owner-id - The ID of the prefix list owner.
\n prefix-list-id - The ID of the prefix list.
\n prefix-list-name - The name of the prefix list.
One or more filters.
\n\n owner-id - The ID of the prefix list owner.
\n prefix-list-id - The ID of the prefix list.
\n prefix-list-name - The name of the prefix list.
One or more filters.
\n\n nat-gateway-id - The ID of the NAT gateway.
\n state - The state of the NAT gateway (pending |\n failed | available | deleting | deleted).
\n subnet-id - The ID of the subnet in which the NAT gateway resides.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC in which the NAT gateway resides.
One or more filters.
\n\n nat-gateway-id - The ID of the NAT gateway.
\n state - The state of the NAT gateway (pending |\n failed | available | deleting | deleted).
\n subnet-id - The ID of the subnet in which the NAT gateway resides.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC in which the NAT gateway resides.
Describes one or more of your network ACLs.
\n\t\tFor more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
", + "smithy.api#documentation": "Describes one or more of your network ACLs.
\nFor more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -31114,7 +31105,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\t\t\n association.association-id - The ID of an association ID for the ACL.
\n association.network-acl-id - The ID of the network ACL involved in the association.
\n association.subnet-id - The ID of the subnet involved in the association.
\n default - Indicates whether the ACL is the default network ACL for the VPC.
\n entry.cidr - The IPv4 CIDR range specified in the entry.
\n entry.icmp.code - The ICMP code specified in the entry, if any.
\n entry.icmp.type - The ICMP type specified in the entry, if any.
\n entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
\n entry.port-range.from - The start of the port range specified in the entry.
\n entry.port-range.to - The end of the port range specified in the entry.
\n entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
\n entry.rule-action - Allows or denies the matching traffic (allow | deny).
\n entry.egress - A Boolean that indicates the type of rule. Specify true \n\t\t for egress rules, or false for ingress rules.
\n entry.rule-number - The number of an entry (in other words, rule) in\n the set of ACL entries.
\n network-acl-id - The ID of the network ACL.
\n owner-id - The ID of the Amazon Web Services account that owns the network ACL.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the network ACL.
One or more filters.
\n\n association.association-id - The ID of an association ID for the ACL.
\n association.network-acl-id - The ID of the network ACL involved in the association.
\n association.subnet-id - The ID of the subnet involved in the association.
\n default - Indicates whether the ACL is the default network ACL for the VPC.
\n entry.cidr - The IPv4 CIDR range specified in the entry.
\n entry.icmp.code - The ICMP code specified in the entry, if any.
\n entry.icmp.type - The ICMP type specified in the entry, if any.
\n entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
\n entry.port-range.from - The start of the port range specified in the entry.
\n entry.port-range.to - The end of the port range specified in the entry.
\n entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
\n entry.rule-action - Allows or denies the matching traffic (allow | deny).
\n entry.egress - A Boolean that indicates the type of rule. Specify true \n\t\t for egress rules, or false for ingress rules.
\n entry.rule-number - The number of an entry (in other words, rule) in\n the set of ACL entries.
\n network-acl-id - The ID of the network ACL.
\n owner-id - The ID of the Amazon Web Services account that owns the network ACL.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the network ACL.
One or more network ACL IDs.
\n\t\tDefault: Describes all your network ACLs.
", + "smithy.api#documentation": "One or more network ACL IDs.
\nDefault: Describes all your network ACLs.
", "smithy.api#xmlName": "NetworkAclId" } }, @@ -31665,7 +31656,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\t\t\n network-interface-permission.network-interface-permission-id - The ID of the\n\t\t\t\tpermission.
\n network-interface-permission.network-interface-id - The ID of\n\t\t\t\t\tthe network interface.
\n network-interface-permission.aws-account-id - The Amazon Web Services account ID.
\n network-interface-permission.aws-service - The Amazon Web Service.
\n network-interface-permission.permission - The type of\n\t\t\t\t\tpermission (INSTANCE-ATTACH |\n\t\t\t\t\tEIP-ASSOCIATE).
One or more filters.
\n\n network-interface-permission.network-interface-permission-id - The ID of the\n\t\t\t\tpermission.
\n network-interface-permission.network-interface-id - The ID of\n\t\t\t\t\tthe network interface.
\n network-interface-permission.aws-account-id - The Amazon Web Services account ID.
\n network-interface-permission.aws-service - The Amazon Web Service.
\n network-interface-permission.permission - The type of\n\t\t\t\t\tpermission (INSTANCE-ATTACH |\n\t\t\t\t\tEIP-ASSOCIATE).
One or more filters.
\n\t\t\n addresses.private-ip-address - The private IPv4 addresses\n associated with the network interface.
\n addresses.primary - Whether the private IPv4 address is the primary\n IP address associated with the network interface.
\n addresses.association.public-ip - The association ID returned when\n the network interface was associated with the Elastic IP address\n (IPv4).
\n addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
\n association.association-id - The association ID returned when the\n network interface was associated with an IPv4 address.
\n association.allocation-id - The allocation ID returned when you\n allocated the Elastic IP address (IPv4) for your network interface.
\n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.
\n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.
\n association.public-dns-name - The public DNS name for the network\n interface (IPv4).
\n attachment.attachment-id - The ID of the interface attachment.
\n attachment.attach-time - The time that the network interface was attached to an instance.
\n attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
\n attachment.device-index - The device index to which the network interface is attached.
\n attachment.instance-id - The ID of the instance to which the network interface is attached.
\n attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
\n attachment.status - The status of the attachment (attaching | attached | detaching | detached).
\n availability-zone - The Availability Zone of the network interface.
\n description - The description of the network interface.
\n group-id - The ID of a security group associated with the network interface.
\n group-name - The name of a security group associated with the network interface.
\n ipv6-addresses.ipv6-address - An IPv6 address associated with\n the network interface.
\n interface-type - The type of network interface (api_gateway_managed | \n\t\t aws_codestar_connections_managed | branch | efa | \n\t\t gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | \n\t\t interface | iot_rules_managed | lambda | load_balancer | \n\t\t nat_gateway | network_load_balancer | quicksight | \n\t\t transit_gateway | trunk | vpc_endpoint).
\n mac-address - The MAC address of the network interface.
\n network-interface-id - The ID of the network interface.
\n owner-id - The Amazon Web Services account ID of the network interface owner.
\n private-ip-address - The private IPv4 address or addresses of the\n network interface.
\n private-dns-name - The private DNS name of the network interface (IPv4).
\n requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
\n requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service \n\t\t (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
\n source-dest-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform network address translation (NAT) in your VPC.
\n status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.
\n subnet-id - The ID of the subnet for the network interface.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the network interface.
One or more filters.
\n\n addresses.private-ip-address - The private IPv4 addresses\n associated with the network interface.
\n addresses.primary - Whether the private IPv4 address is the primary\n IP address associated with the network interface.
\n addresses.association.public-ip - The association ID returned when\n the network interface was associated with the Elastic IP address\n (IPv4).
\n addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
\n association.association-id - The association ID returned when the\n network interface was associated with an IPv4 address.
\n association.allocation-id - The allocation ID returned when you\n allocated the Elastic IP address (IPv4) for your network interface.
\n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.
\n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.
\n association.public-dns-name - The public DNS name for the network\n interface (IPv4).
\n attachment.attachment-id - The ID of the interface attachment.
\n attachment.attach-time - The time that the network interface was attached to an instance.
\n attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
\n attachment.device-index - The device index to which the network interface is attached.
\n attachment.instance-id - The ID of the instance to which the network interface is attached.
\n attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
\n attachment.status - The status of the attachment (attaching | attached | detaching | detached).
\n availability-zone - The Availability Zone of the network interface.
\n description - The description of the network interface.
\n group-id - The ID of a security group associated with the network interface.
\n group-name - The name of a security group associated with the network interface.
\n ipv6-addresses.ipv6-address - An IPv6 address associated with\n the network interface.
\n interface-type - The type of network interface (api_gateway_managed | \n\t\t aws_codestar_connections_managed | branch | efa | \n\t\t gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | \n\t\t interface | iot_rules_managed | lambda | load_balancer | \n\t\t nat_gateway | network_load_balancer | quicksight | \n\t\t transit_gateway | trunk | vpc_endpoint).
\n mac-address - The MAC address of the network interface.
\n network-interface-id - The ID of the network interface.
\n owner-id - The Amazon Web Services account ID of the network interface owner.
\n private-ip-address - The private IPv4 address or addresses of the\n network interface.
\n private-dns-name - The private DNS name of the network interface (IPv4).
\n requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
\n requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service \n\t\t (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
\n source-dest-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform network address translation (NAT) in your VPC.
\n status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.
\n subnet-id - The ID of the subnet for the network interface.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the network interface.
The network interface IDs.
\n\t\tDefault: Describes all your network interfaces.
", + "smithy.api#documentation": "The network interface IDs.
\nDefault: Describes all your network interfaces.
", "smithy.api#xmlName": "NetworkInterfaceId" } }, @@ -31855,7 +31846,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\n group-name - The name of the placement group.
\n group-arn - The Amazon Resource Name (ARN) of the placement\n group.
\n spread-level - The spread level for the placement group\n (host | rack).
\n state - The state of the placement group (pending |\n available | deleting |\n deleted).
\n strategy - The strategy of the placement group\n (cluster | spread |\n partition).
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
The filters.
\n\n group-name - The name of the placement group.
\n group-arn - The Amazon Resource Name (ARN) of the placement\n group.
\n spread-level - The spread level for the placement group\n (host | rack).
\n state - The state of the placement group (pending |\n available | deleting |\n deleted).
\n strategy - The strategy of the placement group\n (cluster | spread |\n partition).
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
The names of the placement groups.
\nDefault: Describes all your placement groups, or only those otherwise\n specified.
", + "smithy.api#documentation": "The names of the placement groups.
\nDefault: Describes all your placement groups, or only those otherwise\n specified.
", "smithy.api#xmlName": "groupName" } }, @@ -31908,7 +31899,7 @@ "target": "com.amazonaws.ec2#DescribePrefixListsResult" }, "traits": { - "smithy.api#documentation": "Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.
\nWe recommend that you use DescribeManagedPrefixLists instead.
", + "smithy.api#documentation": "Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.
\nWe recommend that you use DescribeManagedPrefixLists instead.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -31931,7 +31922,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n prefix-list-id: The ID of a prefix list.
\n prefix-list-name: The name of a prefix list.
One or more filters.
\n\n prefix-list-id: The ID of a prefix list.
\n prefix-list-name: The name of a prefix list.
One or more filters.
\n\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes the Regions that are enabled for your account, or all Regions.
\nFor a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.
\nFor information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
" + "smithy.api#documentation": "Describes the Regions that are enabled for your account, or all Regions.
\nFor a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.
\nFor information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
" } }, "com.amazonaws.ec2#DescribeRegionsRequest": { @@ -32307,7 +32298,7 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesListingsResult" }, "traits": { - "smithy.api#documentation": "Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
\n\t\tThe Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\n\t\tAs a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
\n\t\tAs a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
\nFor more information, see Reserved Instance Marketplace \n in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
\nThe Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nAs a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
\nAs a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
\nFor more information, see Reserved Instance Marketplace \n in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#DescribeReservedInstancesListingsRequest": { @@ -32366,7 +32357,7 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult" }, "traits": { - "smithy.api#documentation": "Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\n \tFor more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\nFor more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32481,7 +32472,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The maximum duration (in seconds) to filter when searching for offerings.
\n\t\tDefault: 94608000 (3 years)
" + "smithy.api#documentation": "The maximum duration (in seconds) to filter when searching for offerings.
\nDefault: 94608000 (3 years)
" } }, "MaxInstanceCount": { @@ -32489,7 +32480,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of instances to filter when searching for offerings.
\n\t\tDefault: 20
" + "smithy.api#documentation": "The maximum number of instances to filter when searching for offerings.
\nDefault: 20
" } }, "MinDuration": { @@ -32497,7 +32488,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The minimum duration (in seconds) to filter when searching for offerings.
\n\t\tDefault: 2592000 (1 month)
" + "smithy.api#documentation": "The minimum duration (in seconds) to filter when searching for offerings.
\nDefault: 2592000 (1 month)
" } }, "OfferingClass": { @@ -32543,7 +32534,7 @@ "aws.protocols#ec2QueryName": "MaxResults", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.
Default: 100
", + "smithy.api#documentation": "The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.
Default: 100
", "smithy.api#xmlName": "maxResults" } }, @@ -32663,7 +32654,7 @@ "target": "com.amazonaws.ec2#DescribeRouteTablesResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your route tables.
\nEach subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
\n\t\tFor more information, see Route tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
", + "smithy.api#documentation": "Describes one or more of your route tables.
\nEach subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
\nFor more information, see Route tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32688,7 +32679,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\t\t\n association.route-table-association-id - The ID of an association\n ID for the route table.
\n association.route-table-id - The ID of the route table involved in\n the association.
\n association.subnet-id - The ID of the subnet involved in the\n association.
\n association.main - Indicates whether the route table is the main\n route table for the VPC (true | false). Route tables\n that do not have an association ID are not returned in the response.
\n owner-id - The ID of the Amazon Web Services account that owns the route table.
\n route-table-id - The ID of the route table.
\n route.destination-cidr-block - The IPv4 CIDR range specified in a\n route in the table.
\n route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
\n route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service\n specified in a route in the table.
\n route.egress-only-internet-gateway-id - The ID of an\n egress-only Internet gateway specified in a route in the route table.
\n route.gateway-id - The ID of a gateway specified in a route in the table.
\n route.instance-id - The ID of an instance specified in a route in the table.
\n route.nat-gateway-id - The ID of a NAT gateway.
\n route.transit-gateway-id - The ID of a transit gateway.
\n route.origin - Describes how the route was created. \n CreateRouteTable indicates that the route was automatically\n created when the route table was created; CreateRoute indicates\n that the route was manually added to the route table;\n EnableVgwRoutePropagation indicates that the route was\n propagated by route propagation.
\n route.state - The state of a route in the route table\n (active | blackhole). The blackhole state\n indicates that the route's target isn't available (for example, the specified\n gateway isn't attached to the VPC, the specified NAT instance has been\n terminated, and so on).
\n route.vpc-peering-connection-id - The ID of a VPC peering\n\t\t connection specified in a route in the table.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the route table.
One or more filters.
\n\n association.route-table-association-id - The ID of an association\n ID for the route table.
\n association.route-table-id - The ID of the route table involved in\n the association.
\n association.subnet-id - The ID of the subnet involved in the\n association.
\n association.main - Indicates whether the route table is the main\n route table for the VPC (true | false). Route tables\n that do not have an association ID are not returned in the response.
\n owner-id - The ID of the Amazon Web Services account that owns the route table.
\n route-table-id - The ID of the route table.
\n route.destination-cidr-block - The IPv4 CIDR range specified in a\n route in the table.
\n route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
\n route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service\n specified in a route in the table.
\n route.egress-only-internet-gateway-id - The ID of an\n egress-only Internet gateway specified in a route in the route table.
\n route.gateway-id - The ID of a gateway specified in a route in the table.
\n route.instance-id - The ID of an instance specified in a route in the table.
\n route.nat-gateway-id - The ID of a NAT gateway.
\n route.transit-gateway-id - The ID of a transit gateway.
\n route.origin - Describes how the route was created. \n CreateRouteTable indicates that the route was automatically\n created when the route table was created; CreateRoute indicates\n that the route was manually added to the route table;\n EnableVgwRoutePropagation indicates that the route was\n propagated by route propagation.
\n route.state - The state of a route in the route table\n (active | blackhole). The blackhole state\n indicates that the route's target isn't available (for example, the specified\n gateway isn't attached to the VPC, the specified NAT instance has been\n terminated, and so on).
\n route.vpc-peering-connection-id - The ID of a VPC peering\n\t\t connection specified in a route in the table.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the route table.
One or more route table IDs.
\n\t\tDefault: Describes all your route tables.
", + "smithy.api#documentation": "One or more route table IDs.
\nDefault: Describes all your route tables.
", "smithy.api#xmlName": "RouteTableId" } }, @@ -33042,7 +33033,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n group-id - The ID of the security group.
\n security-group-rule-id - The ID of the security group rule.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
One or more filters.
\n\n group-id - The ID of the security group.
\n security-group-rule-id - The ID of the security group rule.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
Describes the specified security groups or all of your security groups.
\nA security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes the specified security groups or all of your security groups.
\nA security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nThe filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
\n\n description - The description of the security group.
\n egress.ip-permission.cidr - An IPv4 CIDR block for an outbound\n security group rule.
\n egress.ip-permission.from-port - For an outbound rule, the\n start of port range for the TCP and UDP protocols, or an ICMP type\n number.
\n egress.ip-permission.group-id - The ID of a security group\n that has been referenced in an outbound security group rule.
\n egress.ip-permission.group-name - The name of a security group\n that is referenced in an outbound security group rule.
\n egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an\n outbound security group rule.
\n egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
\n egress.ip-permission.protocol - The IP protocol for an\n outbound security group rule (tcp | udp |\n icmp, a protocol number, or -1 for all protocols).
\n egress.ip-permission.to-port - For an outbound rule, the end\n of port range for the TCP and UDP protocols, or an ICMP code.
\n egress.ip-permission.user-id - The ID of an Amazon Web Services account that\n has been referenced in an outbound security group rule.
\n group-id - The ID of the security group.
\n group-name - The name of the security group.
\n ip-permission.cidr - An IPv4 CIDR block for an inbound security\n group rule.
\n ip-permission.from-port - For an inbound rule, the start of port\n range for the TCP and UDP protocols, or an ICMP type number.
\n ip-permission.group-id - The ID of a security group that has been\n referenced in an inbound security group rule.
\n ip-permission.group-name - The name of a security group that is\n referenced in an inbound security group rule.
\n ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security\n group rule.
\n ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
\n ip-permission.protocol - The IP protocol for an inbound security\n group rule (tcp | udp | icmp, a\n protocol number, or -1 for all protocols).
\n ip-permission.to-port - For an inbound rule, the end of port range\n for the TCP and UDP protocols, or an ICMP code.
\n ip-permission.user-id - The ID of an Amazon Web Services account that has been\n referenced in an inbound security group rule.
\n owner-id - The Amazon Web Services account ID of the owner of the security group.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC specified when the security group was created.
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
\n\n description - The description of the security group.
\n egress.ip-permission.cidr - An IPv4 CIDR block for an outbound\n security group rule.
\n egress.ip-permission.from-port - For an outbound rule, the\n start of port range for the TCP and UDP protocols, or an ICMP type\n number.
\n egress.ip-permission.group-id - The ID of a security group\n that has been referenced in an outbound security group rule.
\n egress.ip-permission.group-name - The name of a security group\n that is referenced in an outbound security group rule.
\n egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an\n outbound security group rule.
\n egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
\n egress.ip-permission.protocol - The IP protocol for an\n outbound security group rule (tcp | udp |\n icmp, a protocol number, or -1 for all protocols).
\n egress.ip-permission.to-port - For an outbound rule, the end\n of port range for the TCP and UDP protocols, or an ICMP code.
\n egress.ip-permission.user-id - The ID of an Amazon Web Services account that\n has been referenced in an outbound security group rule.
\n group-id - The ID of the security group.
\n group-name - The name of the security group.
\n ip-permission.cidr - An IPv4 CIDR block for an inbound security\n group rule.
\n ip-permission.from-port - For an inbound rule, the start of port\n range for the TCP and UDP protocols, or an ICMP type number.
\n ip-permission.group-id - The ID of a security group that has been\n referenced in an inbound security group rule.
\n ip-permission.group-name - The name of a security group that is\n referenced in an inbound security group rule.
\n ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security\n group rule.
\n ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
\n ip-permission.protocol - The IP protocol for an inbound security\n group rule (tcp | udp | icmp, a\n protocol number, or -1 for all protocols).
\n ip-permission.to-port - For an inbound rule, the end of port range\n for the TCP and UDP protocols, or an ICMP code.
\n ip-permission.user-id - The ID of an Amazon Web Services account that has been\n referenced in an inbound security group rule.
\n owner-id - The Amazon Web Services account ID of the owner of the security group.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC specified when the security group was created.
Describes the events for the specified Spot Fleet request during the specified\n time.
\nSpot Fleet events are delayed by up to 30 seconds before they can be described. This\n ensures that you can query by the last evaluated time and not miss a recorded event.\n Spot Fleet events are available for 48 hours.
\nFor more information, see Monitor fleet events using Amazon\n EventBridge in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Describes the events for the specified Spot Fleet request during the specified\n time.
\nSpot Fleet events are delayed by up to 30 seconds before they can be described. This\n ensures that you can query by the last evaluated time and not miss a recorded event.\n Spot Fleet events are available for 48 hours.
\nFor more information, see Monitor fleet events using Amazon\n EventBridge in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults": { @@ -33739,7 +33730,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "LastEvaluatedTime", - "smithy.api#documentation": "The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.
\nIf nextToken indicates that there are more results, this value is not\n present.
The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.
\nIf nextToken indicates that there are more results, this value is not\n present.
Describes your Spot Fleet requests.
\nSpot Fleet requests are deleted 48 hours after they are canceled and their instances\n are terminated.
", + "smithy.api#documentation": "Describes your Spot Fleet requests.
\nSpot Fleet requests are deleted 48 hours after they are canceled and their instances\n are terminated.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -33867,7 +33858,7 @@ "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult" }, "traits": { - "smithy.api#documentation": "Describes the specified Spot Instance requests.
\nYou can use DescribeSpotInstanceRequests to find a running Spot Instance by\n examining the response. If the status of the Spot Instance is fulfilled, the\n instance ID appears in the response and contains the identifier of the instance.\n Alternatively, you can use DescribeInstances\n with a filter to look for instances where the instance lifecycle is\n spot.
We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of results returned. This paginates the output, which makes the list\n more manageable and returns the results faster. If the list of results exceeds your\n MaxResults value, then that number of results is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n results.
Spot Instance requests are deleted four hours after they are canceled and their instances are\n terminated.
", + "smithy.api#documentation": "Describes the specified Spot Instance requests.
\nYou can use DescribeSpotInstanceRequests to find a running Spot Instance by\n examining the response. If the status of the Spot Instance is fulfilled, the\n instance ID appears in the response and contains the identifier of the instance.\n Alternatively, you can use DescribeInstances\n with a filter to look for instances where the instance lifecycle is\n spot.
We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of results returned. This paginates the output, which makes the list\n more manageable and returns the results faster. If the list of results exceeds your\n MaxResults value, then that number of results is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n results.
Spot Instance requests are deleted four hours after they are canceled and their instances are\n terminated.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -33958,7 +33949,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n availability-zone-group - The Availability Zone group.
\n create-time - The time stamp when the Spot Instance request was\n created.
\n fault-code - The fault code related to the request.
\n fault-message - The fault message related to the request.
\n instance-id - The ID of the instance that fulfilled the\n request.
\n launch-group - The Spot Instance launch group.
\n launch.block-device-mapping.delete-on-termination - Indicates\n whether the EBS volume is deleted on instance termination.
\n launch.block-device-mapping.device-name - The device name for the\n volume in the block device mapping (for example, /dev/sdh or\n xvdh).
\n launch.block-device-mapping.snapshot-id - The ID of the snapshot\n for the EBS volume.
\n launch.block-device-mapping.volume-size - The size of the EBS\n volume, in GiB.
\n launch.block-device-mapping.volume-type - The type of EBS volume:\n gp2 for General Purpose SSD, io1 or\n io2 for Provisioned IOPS SSD, st1 for Throughput\n Optimized HDD, sc1for Cold HDD, or standard for\n Magnetic.
\n launch.group-id - The ID of the security group for the\n instance.
\n launch.group-name - The name of the security group for the\n instance.
\n launch.image-id - The ID of the AMI.
\n launch.instance-type - The type of instance (for example,\n m3.medium).
\n launch.kernel-id - The kernel ID.
\n launch.key-name - The name of the key pair the instance launched\n with.
\n launch.monitoring-enabled - Whether detailed monitoring is\n enabled for the Spot Instance.
\n launch.ramdisk-id - The RAM disk ID.
\n launched-availability-zone - The Availability Zone in which the\n request is launched.
\n network-interface.addresses.primary - Indicates whether the IP\n address is the primary private IP address.
\n network-interface.delete-on-termination - Indicates whether the\n network interface is deleted when the instance is terminated.
\n network-interface.description - A description of the network\n interface.
\n network-interface.device-index - The index of the device for the\n network interface attachment on the instance.
\n network-interface.group-id - The ID of the security group\n associated with the network interface.
\n network-interface.network-interface-id - The ID of the network\n interface.
\n network-interface.private-ip-address - The primary private IP\n address of the network interface.
\n network-interface.subnet-id - The ID of the subnet for the\n instance.
\n product-description - The product description associated with the\n instance (Linux/UNIX | Windows).
\n spot-instance-request-id - The Spot Instance request ID.
\n spot-price - The maximum hourly price for any Spot Instance\n launched to fulfill the request.
\n state - The state of the Spot Instance request (open\n | active | closed | cancelled |\n failed). Spot request status information can help you track\n your Amazon EC2 Spot Instance requests. For more information, see Spot\n request status in the Amazon EC2 User Guide for Linux Instances.
\n status-code - The short code describing the most recent\n evaluation of your Spot Instance request.
\n status-message - The message explaining the status of the Spot\n Instance request.
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n type - The type of Spot Instance request (one-time |\n persistent).
\n valid-from - The start date of the request.
\n valid-until - The end date of the request.
One or more filters.
\n\n availability-zone-group - The Availability Zone group.
\n create-time - The time stamp when the Spot Instance request was\n created.
\n fault-code - The fault code related to the request.
\n fault-message - The fault message related to the request.
\n instance-id - The ID of the instance that fulfilled the\n request.
\n launch-group - The Spot Instance launch group.
\n launch.block-device-mapping.delete-on-termination - Indicates\n whether the EBS volume is deleted on instance termination.
\n launch.block-device-mapping.device-name - The device name for the\n volume in the block device mapping (for example, /dev/sdh or\n xvdh).
\n launch.block-device-mapping.snapshot-id - The ID of the snapshot\n for the EBS volume.
\n launch.block-device-mapping.volume-size - The size of the EBS\n volume, in GiB.
\n launch.block-device-mapping.volume-type - The type of EBS volume:\n gp2 for General Purpose SSD, io1 or\n io2 for Provisioned IOPS SSD, st1 for Throughput\n Optimized HDD, sc1for Cold HDD, or standard for\n Magnetic.
\n launch.group-id - The ID of the security group for the\n instance.
\n launch.group-name - The name of the security group for the\n instance.
\n launch.image-id - The ID of the AMI.
\n launch.instance-type - The type of instance (for example,\n m3.medium).
\n launch.kernel-id - The kernel ID.
\n launch.key-name - The name of the key pair the instance launched\n with.
\n launch.monitoring-enabled - Whether detailed monitoring is\n enabled for the Spot Instance.
\n launch.ramdisk-id - The RAM disk ID.
\n launched-availability-zone - The Availability Zone in which the\n request is launched.
\n network-interface.addresses.primary - Indicates whether the IP\n address is the primary private IP address.
\n network-interface.delete-on-termination - Indicates whether the\n network interface is deleted when the instance is terminated.
\n network-interface.description - A description of the network\n interface.
\n network-interface.device-index - The index of the device for the\n network interface attachment on the instance.
\n network-interface.group-id - The ID of the security group\n associated with the network interface.
\n network-interface.network-interface-id - The ID of the network\n interface.
\n network-interface.private-ip-address - The primary private IP\n address of the network interface.
\n network-interface.subnet-id - The ID of the subnet for the\n instance.
\n product-description - The product description associated with the\n instance (Linux/UNIX | Windows).
\n spot-instance-request-id - The Spot Instance request ID.
\n spot-price - The maximum hourly price for any Spot Instance\n launched to fulfill the request.
\n state - The state of the Spot Instance request (open\n | active | closed | cancelled |\n failed). Spot request status information can help you track\n your Amazon EC2 Spot Instance requests. For more information, see Spot\n request status in the Amazon EC2 User Guide for Linux Instances.
\n status-code - The short code describing the most recent\n evaluation of your Spot Instance request.
\n status-message - The message explaining the status of the Spot\n Instance request.
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n type - The type of Spot Instance request (one-time |\n persistent).
\n valid-from - The start date of the request.
\n valid-until - The end date of the request.
Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide for Linux Instances.
\nWhen you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.
", + "smithy.api#documentation": "Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide for Linux Instances.
\nWhen you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -34046,7 +34037,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n availability-zone - The Availability Zone for which prices should\n be returned.
\n instance-type - The type of instance (for example,\n m3.medium).
\n product-description - The product description for the Spot price\n (Linux/UNIX | Red Hat Enterprise Linux |\n SUSE Linux | Windows | Linux/UNIX (Amazon\n VPC) | Red Hat Enterprise Linux (Amazon VPC) |\n SUSE Linux (Amazon VPC) | Windows (Amazon\n VPC)).
\n spot-price - The Spot price. The value must match exactly (or use\n wildcards; greater than or less than comparison is not supported).
\n timestamp - The time stamp of the Spot price history, in UTC format\n (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n You can use wildcards (* and ?). Greater than or less than comparison is not\n supported.
One or more filters.
\n\n availability-zone - The Availability Zone for which prices should\n be returned.
\n instance-type - The type of instance (for example,\n m3.medium).
\n product-description - The product description for the Spot price\n (Linux/UNIX | Red Hat Enterprise Linux |\n SUSE Linux | Windows | Linux/UNIX (Amazon\n VPC) | Red Hat Enterprise Linux (Amazon VPC) |\n SUSE Linux (Amazon VPC) | Windows (Amazon\n VPC)).
\n spot-price - The Spot price. The value must match exactly (or use\n wildcards; greater than or less than comparison is not supported).
\n timestamp - The time stamp of the Spot price history, in UTC format\n (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n You can use wildcards (* and ?). Greater than or less than comparison is not\n supported.
One or more filters.
\n\n availability-zone - The Availability Zone for the subnet. You can also use\n availabilityZone as the filter name.
\n availability-zone-id - The ID of the Availability Zone for the subnet.\n You can also use availabilityZoneId as the filter name.
\n available-ip-address-count - The number of IPv4 addresses in the\n subnet that are available.
\n cidr-block - The IPv4 CIDR block of the subnet. The CIDR block\n you specify must exactly match the subnet's CIDR block for information to be\n returned for the subnet. You can also use cidr or\n cidrBlock as the filter names.
\n customer-owned-ipv4-pool - The customer-owned IPv4 address pool\n associated with the subnet.
\n default-for-az - Indicates whether this is the default subnet for\n the Availability Zone (true | false). You can also use\n defaultForAz as the filter name.
\n enable-dns64 - Indicates whether DNS queries made to the\n Amazon-provided DNS Resolver in this subnet should return synthetic IPv6\n addresses for IPv4-only destinations.
\n enable-lni-at-device-index - Indicates the device position for\n local network interfaces in this subnet. For example, 1 indicates\n local network interfaces in this subnet are the secondary network interface\n (eth1).
\n ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR\n block associated with the subnet.
\n ipv6-cidr-block-association.association-id - An association ID\n for an IPv6 CIDR block associated with the subnet.
\n ipv6-cidr-block-association.state - The state of an IPv6 CIDR\n block associated with the subnet.
\n ipv6-native - Indicates whether this is an IPv6 only subnet\n (true | false).
\n map-customer-owned-ip-on-launch - Indicates whether a network\n interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
\n map-public-ip-on-launch - Indicates whether instances launched in\n this subnet receive a public IPv4 address.
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
\n owner-id - The ID of the Amazon Web Services account that owns the\n subnet.
\n private-dns-name-options-on-launch.hostname-type - The type of\n hostname to assign to instances in the subnet at launch. For IPv4-only and\n dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the\n instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6\n only subnets, an instance DNS name must be based on the instance ID\n (resource-name).
\n private-dns-name-options-on-launch.enable-resource-name-dns-a-record\n - Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.
\n private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record\n - Indicates whether to respond to DNS queries for instance hostnames with DNS\n AAAA records.
\n state - The state of the subnet (pending | available).
\n subnet-arn - The Amazon Resource Name (ARN) of the subnet.
\n subnet-id - The ID of the subnet.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the subnet.
One or more filters.
\n\n availability-zone - The Availability Zone for the subnet. You can also use\n availabilityZone as the filter name.
\n availability-zone-id - The ID of the Availability Zone for the subnet.\n You can also use availabilityZoneId as the filter name.
\n available-ip-address-count - The number of IPv4 addresses in the\n subnet that are available.
\n cidr-block - The IPv4 CIDR block of the subnet. The CIDR block\n you specify must exactly match the subnet's CIDR block for information to be\n returned for the subnet. You can also use cidr or\n cidrBlock as the filter names.
\n customer-owned-ipv4-pool - The customer-owned IPv4 address pool\n associated with the subnet.
\n default-for-az - Indicates whether this is the default subnet for\n the Availability Zone (true | false). You can also use\n defaultForAz as the filter name.
\n enable-dns64 - Indicates whether DNS queries made to the\n Amazon-provided DNS Resolver in this subnet should return synthetic IPv6\n addresses for IPv4-only destinations.
\n enable-lni-at-device-index - Indicates the device position for\n local network interfaces in this subnet. For example, 1 indicates\n local network interfaces in this subnet are the secondary network interface\n (eth1).
\n ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR\n block associated with the subnet.
\n ipv6-cidr-block-association.association-id - An association ID\n for an IPv6 CIDR block associated with the subnet.
\n ipv6-cidr-block-association.state - The state of an IPv6 CIDR\n block associated with the subnet.
\n ipv6-native - Indicates whether this is an IPv6 only subnet\n (true | false).
\n map-customer-owned-ip-on-launch - Indicates whether a network\n interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
\n map-public-ip-on-launch - Indicates whether instances launched in\n this subnet receive a public IPv4 address.
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
\n owner-id - The ID of the Amazon Web Services account that owns the\n subnet.
\n private-dns-name-options-on-launch.hostname-type - The type of\n hostname to assign to instances in the subnet at launch. For IPv4-only and\n dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the\n instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6\n only subnets, an instance DNS name must be based on the instance ID\n (resource-name).
\n private-dns-name-options-on-launch.enable-resource-name-dns-a-record\n - Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.
\n private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record\n - Indicates whether to respond to DNS queries for instance hostnames with DNS\n AAAA records.
\n state - The state of the subnet (pending | available).
\n subnet-arn - The Amazon Resource Name (ARN) of the subnet.
\n subnet-id - The ID of the subnet.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the subnet.
One or more subnet IDs.
\n\t\tDefault: Describes all your subnets.
", + "smithy.api#documentation": "One or more subnet IDs.
\nDefault: Describes all your subnets.
", "smithy.api#xmlName": "SubnetId" } }, @@ -34865,7 +34856,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. The possible values are:
\n\n state - The state of the Connect peer (pending |\n available | deleting |\n deleted).
\n transit-gateway-attachment-id - The ID of the attachment.
\n transit-gateway-connect-peer-id - The ID of the Connect peer.
One or more filters. The possible values are:
\n\n state - The state of the Connect peer (pending |\n available | deleting |\n deleted).
\n transit-gateway-attachment-id - The ID of the attachment.
\n transit-gateway-connect-peer-id - The ID of the Connect peer.
One or more filters. The possible values are:
\n\n options.protocol - The tunnel protocol (gre).
\n state - The state of the attachment (initiating |\n initiatingRequest | pendingAcceptance |\n rollingBack | pending | available |\n modifying | deleting | deleted |\n failed | rejected | rejecting |\n failing).
\n transit-gateway-attachment-id - The ID of the\n Connect attachment.
\n transit-gateway-id - The ID of the transit gateway.
\n transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
One or more filters. The possible values are:
\n\n options.protocol - The tunnel protocol (gre).
\n state - The state of the attachment (initiating |\n initiatingRequest | pendingAcceptance |\n rollingBack | pending | available |\n modifying | deleting | deleted |\n failed | rejected | rejecting |\n failing).
\n transit-gateway-attachment-id - The ID of the\n Connect attachment.
\n transit-gateway-id - The ID of the transit gateway.
\n transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
One or more filters. The possible values are:
\n\n state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
\n transit-gateway-id - The ID of the transit gateway.
\n transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
One or more filters. The possible values are:
\n\n state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
\n transit-gateway-id - The ID of the transit gateway.
\n transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
One or more filters. The possible values are:
\n\n transit-gateway-attachment-id - The ID of the transit gateway attachment.
\n local-owner-id - The ID of your Amazon Web Services account.
\n remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
\n state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
\n transit-gateway-id - The ID of the transit gateway.
One or more filters. The possible values are:
\n\n transit-gateway-attachment-id - The ID of the transit gateway attachment.
\n local-owner-id - The ID of your Amazon Web Services account.
\n remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
\n state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
\n transit-gateway-id - The ID of the transit gateway.
This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.
\nDescribes one or more network interface trunk associations.
", + "smithy.api#documentation": "This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.
\nDescribes one or more network interface trunk associations.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -35595,7 +35586,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n gre-key - The ID of a trunk interface association.
\n interface-protocol - The interface protocol. Valid values are VLAN and GRE.
One or more filters.
\n\n gre-key - The ID of a trunk interface association.
\n interface-protocol - The interface protocol. Valid values are VLAN and GRE.
The filters.
\n\n attachment.attach-time - The time stamp when the attachment\n initiated.
\n attachment.delete-on-termination - Whether the volume is deleted on\n instance termination.
\n attachment.device - The device name specified in the block device mapping\n (for example, /dev/sda1).
\n attachment.instance-id - The ID of the instance the volume is attached\n to.
\n attachment.status - The attachment state (attaching |\n attached | detaching).
\n availability-zone - The Availability Zone in which the volume was\n created.
\n create-time - The time stamp when the volume was created.
\n encrypted - Indicates whether the volume is encrypted (true\n | false)
\n multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true\n \t\t\t| false)
\n fast-restored - Indicates whether the volume was created from a \n snapshot that is enabled for fast snapshot restore (true | \n false).
\n size - The size of the volume, in GiB.
\n snapshot-id - The snapshot from which the volume was created.
\n status - The state of the volume (creating |\n available | in-use | deleting |\n deleted | error).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n volume-id - The volume ID.
\n volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | \n st1 | sc1| standard)
The filters.
\n\n attachment.attach-time - The time stamp when the attachment\n initiated.
\n attachment.delete-on-termination - Whether the volume is deleted on\n instance termination.
\n attachment.device - The device name specified in the block device mapping\n (for example, /dev/sda1).
\n attachment.instance-id - The ID of the instance the volume is attached\n to.
\n attachment.status - The attachment state (attaching |\n attached | detaching).
\n availability-zone - The Availability Zone in which the volume was\n created.
\n create-time - The time stamp when the volume was created.
\n encrypted - Indicates whether the volume is encrypted (true\n | false)
\n multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true\n \t\t\t| false)
\n fast-restored - Indicates whether the volume was created from a \n snapshot that is enabled for fast snapshot restore (true | \n false).
\n size - The size of the volume, in GiB.
\n snapshot-id - The snapshot from which the volume was created.
\n status - The state of the volume (creating |\n available | in-use | deleting |\n deleted | error).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n volume-id - The volume ID.
\n volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | \n st1 | sc1| standard)
Describes the ClassicLink status of one or more VPCs.
\n\tWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n\tDescribes the ClassicLink status of one or more VPCs.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nOne or more filters.
\n\t\t\n is-classic-link-enabled - Whether the VPC is enabled for ClassicLink\n\t\t\t\t\t (true | false).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n is-classic-link-enabled - Whether the VPC is enabled for ClassicLink\n\t\t\t\t\t (true | false).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n connection-notification-arn - The ARN of the SNS topic for the\n notification.
\n connection-notification-id - The ID of the\n notification.
\n connection-notification-state - The state of the notification\n (Enabled | Disabled).
\n connection-notification-type - The type of notification\n (Topic).
\n service-id - The ID of the endpoint service.
\n vpc-endpoint-id - The ID of the VPC endpoint.
One or more filters.
\n\n connection-notification-arn - The ARN of the SNS topic for the\n notification.
\n connection-notification-id - The ID of the\n notification.
\n connection-notification-state - The state of the notification\n (Enabled | Disabled).
\n connection-notification-type - The type of notification\n (Topic).
\n service-id - The ID of the endpoint service.
\n vpc-endpoint-id - The ID of the VPC endpoint.
One or more filters.
\n\t\t\n ip-address-type - The IP address type (ipv4 | ipv6).
\n service-id - The ID of the service.
\n vpc-endpoint-owner - The ID of the Amazon Web Services account ID \n\t\t that owns the endpoint.
\n vpc-endpoint-state - The state of the endpoint\n\t\t\t (pendingAcceptance | pending |\n\t\t\t available | deleting | deleted |\n\t\t\t rejected | failed).
\n vpc-endpoint-id - The ID of the endpoint.
One or more filters.
\n\n ip-address-type - The IP address type (ipv4 | ipv6).
\n service-id - The ID of the service.
\n vpc-endpoint-owner - The ID of the Amazon Web Services account ID \n\t\t that owns the endpoint.
\n vpc-endpoint-state - The state of the endpoint\n\t\t\t (pendingAcceptance | pending |\n\t\t\t available | deleting | deleted |\n\t\t\t rejected | failed).
\n vpc-endpoint-id - The ID of the endpoint.
One or more filters.
\n\t\t\n service-name - The name of the service.
\n service-id - The ID of the service.
\n service-state - The state of the service (Pending |\n Available | Deleting | Deleted |\n Failed).
\n supported-ip-address-types - The IP address type (ipv4 | ipv6).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n service-name - The name of the service.
\n service-id - The ID of the service.
\n service-state - The state of the service (Pending |\n Available | Deleting | Deleted |\n Failed).
\n supported-ip-address-types - The IP address type (ipv4 | ipv6).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\t\t\n principal - The ARN of the principal.
\n principal-type - The principal type (All |\n\t\t\t\t\t\tService | OrganizationUnit | Account\n\t\t\t\t\t| User | Role).
One or more filters.
\n\n principal - The ARN of the principal.
\n principal-type - The principal type (All |\n\t\t\t\t\t\tService | OrganizationUnit | Account\n\t\t\t\t\t| User | Role).
Describes available services to which you can create a VPC endpoint.
\nWhen the service provider and the consumer have different accounts in multiple\n Availability Zones, and the consumer views the VPC endpoint service information, the\n response only includes the common Availability Zones. For example, when the service\n provider account uses us-east-1a and us-east-1c and the\n consumer uses us-east-1a and us-east-1b, the response includes\n the VPC endpoint services in the common Availability Zone,\n us-east-1a.
Describes available services to which you can create a VPC endpoint.
\nWhen the service provider and the consumer have different accounts in multiple\n Availability Zones, and the consumer views the VPC endpoint service information, the\n response only includes the common Availability Zones. For example, when the service\n provider account uses us-east-1a and us-east-1c and the\n consumer uses us-east-1a and us-east-1b, the response includes\n the VPC endpoint services in the common Availability Zone,\n us-east-1a.
One or more filters.
\n\n owner - The ID or alias of the Amazon Web Services account that owns \n the service.
\n service-name - The name of the service.
\n service-type - The type of service (Interface |\n Gateway | GatewayLoadBalancer).
\n supported-ip-address-types - The IP address type (ipv4 | ipv6).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n owner - The ID or alias of the Amazon Web Services account that owns \n the service.
\n service-name - The name of the service.
\n service-type - The type of service (Interface |\n Gateway | GatewayLoadBalancer).
\n supported-ip-address-types - The IP address type (ipv4 | ipv6).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
\nConstraint: If the value is greater than 1,000, we return only 1,000 items.
" + "smithy.api#documentation": "The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
\nConstraint: If the value is greater than 1,000, we return only 1,000 items.
" } }, "NextToken": { @@ -37162,7 +37153,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n ip-address-type - The IP address type (ipv4 | ipv6).
\n service-name - The name of the service.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC in which the endpoint resides.
\n vpc-endpoint-id - The ID of the endpoint.
\n vpc-endpoint-state - The state of the endpoint\n (pendingAcceptance | pending |\n available | deleting | deleted |\n rejected | failed).
\n vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
One or more filters.
\n\n ip-address-type - The IP address type (ipv4 | ipv6).
\n service-name - The name of the service.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC in which the endpoint resides.
\n vpc-endpoint-id - The ID of the endpoint.
\n vpc-endpoint-state - The state of the endpoint\n (pendingAcceptance | pending |\n available | deleting | deleted |\n rejected | failed).
\n vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
\nConstraint: If the value is greater than 1,000, we return only 1,000 items.
" + "smithy.api#documentation": "The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
\nConstraint: If the value is greater than 1,000, we return only 1,000 items.
" } }, "NextToken": { @@ -37286,7 +37277,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter\n VPC.
\n accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the\n accepter VPC.
\n accepter-vpc-info.vpc-id - The ID of the accepter VPC.
\n expiration-time - The expiration date and time for the VPC peering\n connection.
\n requester-vpc-info.cidr-block - The IPv4 CIDR block of the\n requester's VPC.
\n requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the\n requester VPC.
\n requester-vpc-info.vpc-id - The ID of the requester VPC.
\n status-code - The status of the VPC peering connection\n (pending-acceptance | failed |\n expired | provisioning | active |\n deleting | deleted |\n rejected).
\n status-message - A message that provides more information about the status\n of the VPC peering connection, if applicable.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-peering-connection-id - The ID of the VPC peering connection.
One or more filters.
\n\n accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter\n VPC.
\n accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the\n accepter VPC.
\n accepter-vpc-info.vpc-id - The ID of the accepter VPC.
\n expiration-time - The expiration date and time for the VPC peering\n connection.
\n requester-vpc-info.cidr-block - The IPv4 CIDR block of the\n requester's VPC.
\n requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the\n requester VPC.
\n requester-vpc-info.vpc-id - The ID of the requester VPC.
\n status-code - The status of the VPC peering connection\n (pending-acceptance | failed |\n expired | provisioning | active |\n deleting | deleted |\n rejected).
\n status-message - A message that provides more information about the status\n of the VPC peering connection, if applicable.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-peering-connection-id - The ID of the VPC peering connection.
One or more filters.
\n\n cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you\n specify must exactly match the VPC's CIDR block for information to be returned\n for the VPC. Must contain the slash followed by one or two digits (for example,\n /28).
\n cidr-block-association.cidr-block - An IPv4 CIDR block associated with the\n VPC.
\n cidr-block-association.association-id - The association ID for\n an IPv4 CIDR block associated with the VPC.
\n cidr-block-association.state - The state of an IPv4 CIDR block\n associated with the VPC.
\n dhcp-options-id - The ID of a set of DHCP options.
\n ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR\n block associated with the VPC.
\n ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
\n ipv6-cidr-block-association.association-id - The association\n ID for an IPv6 CIDR block associated with the VPC.
\n ipv6-cidr-block-association.state - The state of an IPv6 CIDR\n block associated with the VPC.
\n is-default - Indicates whether the VPC is the default VPC.
\n owner-id - The ID of the Amazon Web Services account that owns the VPC.
\n state - The state of the VPC (pending | available).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC.
One or more filters.
\n\n cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you\n specify must exactly match the VPC's CIDR block for information to be returned\n for the VPC. Must contain the slash followed by one or two digits (for example,\n /28).
\n cidr-block-association.cidr-block - An IPv4 CIDR block associated with the\n VPC.
\n cidr-block-association.association-id - The association ID for\n an IPv4 CIDR block associated with the VPC.
\n cidr-block-association.state - The state of an IPv4 CIDR block\n associated with the VPC.
\n dhcp-options-id - The ID of a set of DHCP options.
\n ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR\n block associated with the VPC.
\n ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
\n ipv6-cidr-block-association.association-id - The association\n ID for an IPv6 CIDR block associated with the VPC.
\n ipv6-cidr-block-association.state - The state of an IPv6 CIDR\n block associated with the VPC.
\n is-default - Indicates whether the VPC is the default VPC.
\n owner-id - The ID of the Amazon Web Services account that owns the VPC.
\n state - The state of the VPC (pending | available).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC.
One or more VPC IDs.
\n\t\tDefault: Describes all your VPCs.
", + "smithy.api#documentation": "One or more VPC IDs.
\nDefault: Describes all your VPCs.
", "smithy.api#xmlName": "VpcId" } }, @@ -37482,7 +37473,7 @@ "target": "com.amazonaws.ec2#DescribeVpnConnectionsResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your VPN connections.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
", + "smithy.api#documentation": "Describes one or more of your VPN connections.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
", "smithy.waiters#waitable": { "VpnConnectionAvailable": { "acceptors": [ @@ -37553,14 +37544,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n customer-gateway-configuration - The configuration information\n for the customer gateway.
\n customer-gateway-id - The ID of a customer gateway associated\n with the VPN connection.
\n state - The state of the VPN connection (pending |\n available | deleting |\n deleted).
\n option.static-routes-only - Indicates whether the connection has\n static routes only. Used for devices that do not support Border Gateway Protocol\n (BGP).
\n route.destination-cidr-block - The destination CIDR block. This\n corresponds to the subnet used in a customer data center.
\n bgp-asn - The BGP Autonomous System Number (ASN) associated with\n a BGP device.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n type - The type of VPN connection. Currently the only supported\n type is ipsec.1.
\n vpn-connection-id - The ID of the VPN connection.
\n vpn-gateway-id - The ID of a virtual private gateway associated\n with the VPN connection.
\n transit-gateway-id - The ID of a transit gateway associated with\n the VPN connection.
One or more filters.
\n\n customer-gateway-configuration - The configuration information\n for the customer gateway.
\n customer-gateway-id - The ID of a customer gateway associated\n with the VPN connection.
\n state - The state of the VPN connection (pending |\n available | deleting |\n deleted).
\n option.static-routes-only - Indicates whether the connection has\n static routes only. Used for devices that do not support Border Gateway Protocol\n (BGP).
\n route.destination-cidr-block - The destination CIDR block. This\n corresponds to the subnet used in a customer data center.
\n bgp-asn - The BGP Autonomous System Number (ASN) associated with\n a BGP device.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n type - The type of VPN connection. Currently the only supported\n type is ipsec.1.
\n vpn-connection-id - The ID of the VPN connection.
\n vpn-gateway-id - The ID of a virtual private gateway associated\n with the VPN connection.
\n transit-gateway-id - The ID of a transit gateway associated with\n the VPN connection.
One or more VPN connection IDs.
\nDefault: Describes your VPN connections.
", + "smithy.api#documentation": "One or more VPN connection IDs.
\nDefault: Describes your VPN connections.
", "smithy.api#xmlName": "VpnConnectionId" } }, @@ -37604,7 +37595,7 @@ "target": "com.amazonaws.ec2#DescribeVpnGatewaysResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your virtual private gateways.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" + "smithy.api#documentation": "Describes one or more of your virtual private gateways.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
" } }, "com.amazonaws.ec2#DescribeVpnGatewaysRequest": { @@ -37613,14 +37604,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n amazon-side-asn - The Autonomous System Number (ASN) for the\n Amazon side of the gateway.
\n attachment.state - The current state of the attachment between\n the gateway and the VPC (attaching | attached |\n detaching | detached).
\n attachment.vpc-id - The ID of an attached VPC.
\n availability-zone - The Availability Zone for the virtual private\n gateway (if applicable).
\n state - The state of the virtual private gateway\n (pending | available | deleting |\n deleted).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n type - The type of virtual private gateway. Currently the only\n supported type is ipsec.1.
\n vpn-gateway-id - The ID of the virtual private gateway.
One or more filters.
\n\n amazon-side-asn - The Autonomous System Number (ASN) for the\n Amazon side of the gateway.
\n attachment.state - The current state of the attachment between\n the gateway and the VPC (attaching | attached |\n detaching | detached).
\n attachment.vpc-id - The ID of an attached VPC.
\n availability-zone - The Availability Zone for the virtual private\n gateway (if applicable).
\n state - The state of the virtual private gateway\n (pending | available | deleting |\n deleted).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n type - The type of virtual private gateway. Currently the only\n supported type is ipsec.1.
\n vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
\nDefault: Describes all your virtual private gateways.
", + "smithy.api#documentation": "One or more virtual private gateway IDs.
\nDefault: Describes all your virtual private gateways.
", "smithy.api#xmlName": "VpnGatewayId" } }, @@ -37747,7 +37738,7 @@ "target": "com.amazonaws.ec2#DetachClassicLinkVpcResult" }, "traits": { - "smithy.api#documentation": "We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n\tUnlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
" + "smithy.api#documentation": "We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nUnlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
" } }, "com.amazonaws.ec2#DetachClassicLinkVpcRequest": { @@ -37888,7 +37879,7 @@ "aws.protocols#ec2QueryName": "Force", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether to force a detachment.
\nUse the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata\n might not get updated. This means that the attributes associated\n with the detached network interface might still be visible. The\n instance metadata will get updated when you stop and start the\n instance.
\nSpecifies whether to force a detachment.
\nUse the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata\n might not get updated. This means that the attributes associated\n with the detached network interface might still be visible. The\n instance metadata will get updated when you stop and start the\n instance.
\nDetaches a virtual private gateway from a VPC. You do this if you're planning to turn\n off the VPC and not use it anymore. You can confirm a virtual private gateway has been\n completely detached from a VPC by describing the virtual private gateway (any\n attachments to the virtual private gateway are also described).
\nYou must wait for the attachment's state to switch to detached before you\n can delete the VPC or attach a different VPC to the virtual private gateway.
Detaches a virtual private gateway from a VPC. You do this if you're planning to turn\n off the VPC and not use it anymore. You can confirm a virtual private gateway has been\n completely detached from a VPC by describing the virtual private gateway (any\n attachments to the virtual private gateway are also described).
\nYou must wait for the attachment's state to switch to detached before you\n can delete the VPC or attach a different VPC to the virtual private gateway.
Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. \n\t\t\tWhen you disable faster launching, the AMI uses the standard launch process for each \n\t\t\tinstance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
\n\t\tTo change these settings, you must own the AMI.
\n\t\tDiscontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. \n\t\t\tWhen you disable faster launching, the AMI uses the standard launch process for each \n\t\t\tinstance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
\nTo change these settings, you must own the AMI.
\nDisables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to\n\t\t\tpublic IP addresses when addressed between a linked EC2-Classic instance and instances\n\t\t\tin the VPC to which it's linked. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
\nYou must specify a VPC ID in the request.
\n \nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDisables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to\n\t\t\tpublic IP addresses when addressed between a linked EC2-Classic instance and instances\n\t\t\tin the VPC to which it's linked. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
\nYou must specify a VPC ID in the request.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDisassociates an Elastic IP address from the instance or network interface it's associated with.
\n\t\t\tAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more\n\t\t\tinformation, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.
\n \nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" + "smithy.api#documentation": "Disassociates an Elastic IP address from the instance or network interface it's associated with.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more\n\t\t\tinformation, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" } }, "com.amazonaws.ec2#DisassociateAddressRequest": { @@ -39156,7 +39147,7 @@ "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkResult" }, "traits": { - "smithy.api#documentation": "Disassociates a target network from the specified Client VPN endpoint. When you disassociate the \n\t\t\tlast target network from a Client VPN, the following happens:
\n\t\tThe route that was automatically added for the VPC is deleted
\n\t\t\tAll active client connections are terminated
\n\t\t\tNew client connections are disallowed
\n\t\t\tThe Client VPN endpoint's status changes to pending-associate\n
Disassociates a target network from the specified Client VPN endpoint. When you disassociate the \n\t\t\tlast target network from a Client VPN, the following happens:
\nThe route that was automatically added for the VPC is deleted
\nAll active client connections are terminated
\nNew client connections are disallowed
\nThe Client VPN endpoint's status changes to pending-associate\n
Disassociates an IAM instance profile from a running or stopped instance.
\nUse DescribeIamInstanceProfileAssociations to get the association\n ID.
" + "smithy.api#documentation": "Disassociates an IAM instance profile from a running or stopped instance.
\nUse DescribeIamInstanceProfileAssociations to get the association\n ID.
" } }, "com.amazonaws.ec2#DisassociateIamInstanceProfileRequest": { @@ -39362,7 +39353,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Disassociates a subnet or gateway from a route table.
\n\t\tAfter you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\ttables in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Disassociates a subnet or gateway from a route table.
\nAfter you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\ttables in the Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#DisassociateRouteTableRequest": { @@ -39611,7 +39602,7 @@ "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceResult" }, "traits": { - "smithy.api#documentation": "This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.
\nRemoves an association between a branch network interface with a trunk network interface.
" + "smithy.api#documentation": "This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.
\nRemoves an association between a branch network interface with a trunk network interface.
" } }, "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest": { @@ -39674,7 +39665,7 @@ "target": "com.amazonaws.ec2#DisassociateVpcCidrBlockResult" }, "traits": { - "smithy.api#documentation": "Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must\n specify its association ID. You can get the association ID by using\n DescribeVpcs. You must detach or delete all gateways and resources that\n are associated with the CIDR block before you can disassociate it.
\n\t\tYou cannot disassociate the CIDR block with which you originally created the VPC (the\n\t\t\tprimary CIDR block).
" + "smithy.api#documentation": "Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must\n specify its association ID. You can get the association ID by using\n DescribeVpcs. You must detach or delete all gateways and resources that\n are associated with the CIDR block before you can disassociate it.
\nYou cannot disassociate the CIDR block with which you originally created the VPC (the\n\t\t\tprimary CIDR block).
" } }, "com.amazonaws.ec2#DisassociateVpcCidrBlockRequest": { @@ -40169,7 +40160,7 @@ "aws.protocols#ec2QueryName": "Iops", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
\n io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for\n Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard\n volumes.
The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
\n io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for\n Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard\n volumes.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.
\nThe following are the supported volumes sizes for each volume type:
\n\n gp2 and gp3:1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.
\nThe following are the supported volumes sizes for each volume type:
\n\n gp2 and gp3:1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.
\nThis parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.
\nThis parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.
The throughput that the volume supports, in MiB/s.
\nThis parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
", + "smithy.api#documentation": "The throughput that the volume supports, in MiB/s.
\nThis parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
", "smithy.api#xmlName": "throughput" } }, @@ -40221,7 +40212,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "The ARN of the Outpost on which the snapshot is stored.
\nThis parameter is only supported on BlockDeviceMapping objects called by\n \n CreateImage.
The ARN of the Outpost on which the snapshot is stored.
\nThis parameter is only supported on BlockDeviceMapping objects called by\n \n CreateImage.
Indicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
\nEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.
\nThis parameter is not returned by DescribeImageAttribute.
", + "smithy.api#documentation": "Indicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
\nEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.
\nThis parameter is not returned by DescribeImageAttribute.
", "smithy.api#xmlName": "encrypted" } } @@ -40889,7 +40880,7 @@ } }, "traits": { - "smithy.api#documentation": "ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.
\n\t\tTo improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.
" + "smithy.api#documentation": "ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.
\nTo improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.
" } }, "com.amazonaws.ec2#EnaSrdSupported": { @@ -41061,7 +41052,7 @@ "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult" }, "traits": { - "smithy.api#documentation": "Enables EBS encryption by default for your account in the current Region.
\nAfter you enable encryption by default, the EBS volumes that you create are\n \talways encrypted, either using the default KMS key or the KMS key that you specified\n when you created each volume. For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.
\n \tYou can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.
\nEnabling encryption by default has no effect on the encryption status of your \n existing volumes.
\nAfter you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.
" + "smithy.api#documentation": "Enables EBS encryption by default for your account in the current Region.
\nAfter you enable encryption by default, the EBS volumes that you create are\n \talways encrypted, either using the default KMS key or the KMS key that you specified\n when you created each volume. For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.
\nYou can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.
\nEnabling encryption by default has no effect on the encryption status of your \n existing volumes.
\nAfter you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.
" } }, "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest": { @@ -41101,7 +41092,7 @@ "target": "com.amazonaws.ec2#EnableFastLaunchResult" }, "traits": { - "smithy.api#documentation": "When you enable faster launching for a Windows AMI, images are pre-provisioned, \n\t\t\tusing snapshots to launch instances up to 65% faster. To create the optimized Windows \n\t\t\timage, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. \n\t\t\tThen it creates a set of reserved snapshots that are used for subsequent launches. The \n\t\t\treserved snapshots are automatically replenished as they are used, depending on your \n\t\t\tsettings for launch frequency.
\n\t\tTo change these settings, you must own the AMI.
\n\t\tWhen you enable faster launching for a Windows AMI, images are pre-provisioned, \n\t\t\tusing snapshots to launch instances up to 65% faster. To create the optimized Windows \n\t\t\timage, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. \n\t\t\tThen it creates a set of reserved snapshots that are used for subsequent launches. The \n\t\t\treserved snapshots are automatically replenished as they are used, depending on your \n\t\t\tsettings for launch frequency.
\nTo change these settings, you must own the AMI.
\nThe event.
\n \n\n error events:
\n iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required\n permissions either to launch or terminate an instance.
\n allLaunchSpecsTemporarilyBlacklisted - None of the configurations\n are valid, and several attempts to launch instances have failed. For more\n information, see the description of the event.
\n spotInstanceCountLimitExceeded - You've reached the limit on the\n number of Spot Instances that you can launch.
\n spotFleetRequestConfigurationInvalid - The configuration is not\n valid. For more information, see the description of the event.
\n fleetRequestChange events:
\n active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is\n attempting to maintain the target number of running instances.
\n deleted (EC2 Fleet) / cancelled (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running\n instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are\n terminated.
\n deleted_running (EC2 Fleet) / cancelled_running (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does\n not launch additional instances. Its existing instances continue to run until\n they are interrupted or terminated. The request remains in this state until all\n instances are interrupted or terminated.
\n deleted_terminating (EC2 Fleet) / cancelled_terminating (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and\n its instances are terminating. The request remains in this state until all\n instances are terminated.
\n expired - The EC2 Fleet or Spot Fleet request has expired. If the request was\n created with TerminateInstancesWithExpiration set, a subsequent\n terminated event indicates that the instances are\n terminated.
\n modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified.\n The request remains in this state until the modification is fully\n processed.
\n modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
\n submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2\n is preparing to launch the target number of instances.
\n progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
\n instanceChange events:
\n launched - A new instance was launched.
\n terminated - An instance was terminated by the user.
\n termination_notified - An instance termination notification was\n sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target\n capacity of the fleet was modified down, for example, from a target capacity of\n 4 to a target capacity of 3.
\n Information events:
\n fleetProgressHalted - The price in every launch specification is\n not valid because it is below the Spot price (all the launch specifications have\n produced launchSpecUnusable events). A launch specification might\n become valid if the Spot price changes.
\n launchSpecTemporarilyBlacklisted - The configuration is not valid\n and several attempts to launch instances have failed. For more information, see\n the description of the event.
\n launchSpecUnusable - The price in a launch specification is not\n valid because it is below the Spot price.
\n registerWithLoadBalancersFailed - An attempt to register\n instances with load balancers failed. For more information, see the description\n of the event.
The event.
\n\n error events:
\n iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required\n permissions either to launch or terminate an instance.
\n allLaunchSpecsTemporarilyBlacklisted - None of the configurations\n are valid, and several attempts to launch instances have failed. For more\n information, see the description of the event.
\n spotInstanceCountLimitExceeded - You've reached the limit on the\n number of Spot Instances that you can launch.
\n spotFleetRequestConfigurationInvalid - The configuration is not\n valid. For more information, see the description of the event.
\n fleetRequestChange events:
\n active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is\n attempting to maintain the target number of running instances.
\n deleted (EC2 Fleet) / cancelled (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running\n instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are\n terminated.
\n deleted_running (EC2 Fleet) / cancelled_running (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does\n not launch additional instances. Its existing instances continue to run until\n they are interrupted or terminated. The request remains in this state until all\n instances are interrupted or terminated.
\n deleted_terminating (EC2 Fleet) / cancelled_terminating (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and\n its instances are terminating. The request remains in this state until all\n instances are terminated.
\n expired - The EC2 Fleet or Spot Fleet request has expired. If the request was\n created with TerminateInstancesWithExpiration set, a subsequent\n terminated event indicates that the instances are\n terminated.
\n modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified.\n The request remains in this state until the modification is fully\n processed.
\n modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
\n submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2\n is preparing to launch the target number of instances.
\n progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
\n instanceChange events:
\n launched - A new instance was launched.
\n terminated - An instance was terminated by the user.
\n termination_notified - An instance termination notification was\n sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target\n capacity of the fleet was modified down, for example, from a target capacity of\n 4 to a target capacity of 3.
\n Information events:
\n fleetProgressHalted - The price in every launch specification is\n not valid because it is below the Spot price (all the launch specifications have\n produced launchSpecUnusable events). A launch specification might\n become valid if the Spot price changes.
\n launchSpecTemporarilyBlacklisted - The configuration is not valid\n and several attempts to launch instances have failed. For more information, see\n the description of the event.
\n launchSpecUnusable - The price in a launch specification is not\n valid because it is below the Spot price.
\n registerWithLoadBalancersFailed - An attempt to register\n instances with load balancers failed. For more information, see the description\n of the event.
Request to create a launch template for a fast-launch enabled Windows AMI.
\n\t\tNote - You can specify either the LaunchTemplateName or the \n\t\t\t\tLaunchTemplateId, but not both.
Request to create a launch template for a fast-launch enabled Windows AMI.
\nNote - You can specify either the LaunchTemplateName or the \n\t\t\t\tLaunchTemplateId, but not both.
The ID of the launch template.
\nYou must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
\nYou must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The launch template version number, $Latest, or $Default.\n You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.
If the value is $Default, Amazon EC2 uses the default version of the launch\n template.
The launch template version number, $Latest, or $Default.\n You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.
If the value is $Default, Amazon EC2 uses the default version of the launch\n template.
The Amazon EC2 launch template that can be used by\n a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.
\nFor information about launch templates,\n see Launch an instance from a launch template in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "The Amazon EC2 launch template that can be used by\n a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.
\nFor information about launch templates,\n see Launch an instance from a launch template in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest": { @@ -44627,7 +44618,7 @@ "aws.protocols#ec2QueryName": "MaxAggregationInterval", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.
\nValid Values: 60 | 600\n
The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.
\nValid Values: 60 | 600\n
Indicates whether data retention support is enabled for the AFI.
", "smithy.api#xmlName": "dataRetentionSupport" } + }, + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypesList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypes", + "smithy.api#xmlName": "instanceTypes" + } } }, "traits": { @@ -45023,7 +45021,7 @@ "target": "com.amazonaws.ec2#FpgaImageStateCode", "traits": { "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "The state. The following are the possible values:
\n\t\t\n pending - AFI bitstream generation is in progress.
\n available - The AFI is available for use.
\n failed - AFI bitstream generation failed.
\n unavailable - The AFI is no longer available for use.
The state. The following are the possible values:
\n\n pending - AFI bitstream generation is in progress.
\n available - The AFI is available for use.
\n failed - AFI bitstream generation failed.
\n unavailable - The AFI is no longer available for use.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
" + "smithy.api#documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
" } }, "DryRun": { @@ -45456,7 +45454,7 @@ "target": "com.amazonaws.ec2#CapacityReservationState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
\n\t\t\t\n active - The Capacity Reservation is active and the capacity is available for your use.
\n expired - The Capacity Reservation expired automatically at the date and time specified \n\t\t\t\t\tin your request. The reserved capacity is no longer available for your use.
\n cancelled - The Capacity Reservation was cancelled. The reserved capacity is no\n\t\t\t\t\tlonger available for your use.
\n pending - The Capacity Reservation request was successful but the capacity \n\t\t\t\t\tprovisioning is still pending.
\n failed - The Capacity Reservation request has failed. A request might fail \n\t\t\t\t\tdue to invalid request parameters, capacity constraints, or instance limit constraints. \n\t\t\t\t\tFailed requests are retained for 60 minutes.
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
\n\n active - The Capacity Reservation is active and the capacity is available for your use.
\n expired - The Capacity Reservation expired automatically at the date and time specified \n\t\t\t\t\tin your request. The reserved capacity is no longer available for your use.
\n cancelled - The Capacity Reservation was cancelled. The reserved capacity is no\n\t\t\t\t\tlonger available for your use.
\n pending - The Capacity Reservation request was successful but the capacity \n\t\t\t\t\tprovisioning is still pending.
\n failed - The Capacity Reservation request has failed. A request might fail \n\t\t\t\t\tdue to invalid request parameters, capacity constraints, or instance limit constraints. \n\t\t\t\t\tFailed requests are retained for 60 minutes.
Gets the console output for the specified instance. For Linux instances, the instance\n console output displays the exact console output that would normally be displayed on a\n physical monitor attached to a computer. For Windows instances, the instance console\n output includes the last three system event log errors.
\nBy default, the console output returns buffered information that was posted shortly\n after an instance transition state (start, stop, reboot, or terminate). This information\n is available for at least one hour after the most recent post. Only the most recent 64\n KB of console output is available.
\nYou can optionally retrieve the latest serial console output at any time during the\n instance lifecycle. This option is supported on instance types that use the Nitro\n hypervisor.
\nFor more information, see Instance\n console output in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Gets the console output for the specified instance. For Linux instances, the instance\n console output displays the exact console output that would normally be displayed on a\n physical monitor attached to a computer. For Windows instances, the instance console\n output includes the last three system event log errors.
\nBy default, the console output returns buffered information that was posted shortly\n after an instance transition state (start, stop, reboot, or terminate). This information\n is available for at least one hour after the most recent post. Only the most recent 64\n KB of console output is available.
\nYou can optionally retrieve the latest serial console output at any time during the\n instance lifecycle. This option is supported on instance types that use the Nitro\n hypervisor.
\nFor more information, see Instance\n console output in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#GetConsoleOutputRequest": { @@ -45591,7 +45589,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "When enabled, retrieves the latest console output for the instance.
\nDefault: disabled (false)
When enabled, retrieves the latest console output for the instance.
\nDefault: disabled (false)
Retrieve a JPG-format screenshot of a running instance to help with\n troubleshooting.
\nThe returned content is Base64-encoded.
" + "smithy.api#documentation": "Retrieve a JPG-format screenshot of a running instance to help with\n troubleshooting.
\nThe returned content is Base64-encoded.
" } }, "com.amazonaws.ec2#GetConsoleScreenshotRequest": { @@ -45696,7 +45694,7 @@ "target": "com.amazonaws.ec2#GetDefaultCreditSpecificationResult" }, "traits": { - "smithy.api#documentation": "Describes the default credit option for CPU usage of a burstable performance instance\n family.
\nFor more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Describes the default credit option for CPU usage of a burstable performance instance\n family.
\nFor more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#GetDefaultCreditSpecificationRequest": { @@ -45820,7 +45818,7 @@ "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateResult" }, "traits": { - "smithy.api#documentation": "Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs \n with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. \n Based on the information that you provide, we configure resources in the template to do the following:
\nCreate a table in Athena that maps fields to a custom log format
\nCreate a Lambda function that updates the table with new partitions on a daily, weekly, or\n monthly basis
\nCreate a table partitioned between two timestamps in the past
\nCreate a set of named queries in Athena that you can use to get started quickly
\nGenerates a CloudFormation template that streamlines and automates the integration of VPC flow logs \n with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. \n Based on the information that you provide, we configure resources in the template to do the following:
\nCreate a table in Athena that maps fields to a custom log format
\nCreate a Lambda function that updates the table with new partitions on a daily, weekly, or\n monthly basis
\nCreate a table partitioned between two timestamps in the past
\nCreate a set of named queries in Athena that you can use to get started quickly
\nPreview a reservation purchase with configurations that match those of your Dedicated\n Host. You must have active Dedicated Hosts in your account before you purchase a\n reservation.
\nThis is a preview of the PurchaseHostReservation action and does not\n result in the offering being purchased.
" + "smithy.api#documentation": "Preview a reservation purchase with configurations that match those of your Dedicated\n Host. You must have active Dedicated Hosts in your account before you purchase a\n reservation.
\nThis is a preview of the PurchaseHostReservation action and does not\n result in the offering being purchased.
" } }, "com.amazonaws.ec2#GetHostReservationPurchasePreviewRequest": { @@ -46129,7 +46127,7 @@ "target": "com.amazonaws.ec2#GetInstanceUefiDataResult" }, "traits": { - "smithy.api#documentation": "A binary representation of the UEFI variable store. Only non-volatile variables are\n stored. This is a base64 encoded and zlib compressed binary value that must be properly\n encoded.
\nWhen you use register-image to create\n an AMI, you can create an exact copy of your variable store by passing the UEFI data in\n the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on\n GitHub. You can use the tool to convert the UEFI data into a human-readable format\n (JSON), which you can inspect and modify, and then convert back into the binary format\n to use with register-image.
For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "A binary representation of the UEFI variable store. Only non-volatile variables are\n stored. This is a base64 encoded and zlib compressed binary value that must be properly\n encoded.
\nWhen you use register-image to create\n an AMI, you can create an exact copy of your variable store by passing the UEFI data in\n the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on\n GitHub. You can use the tool to convert the UEFI data into a human-readable format\n (JSON), which you can inspect and modify, and then convert back into the binary format\n to use with register-image.
For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#GetInstanceUefiDataRequest": { @@ -46573,7 +46571,7 @@ "target": "com.amazonaws.ec2#GetLaunchTemplateDataResult" }, "traits": { - "smithy.api#documentation": "Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.
\nThis action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests,\n DescribeInstanceCreditSpecifications, DescribeVolumes,\n DescribeInstanceAttribute, and DescribeElasticGpus. Or,\n you can allow describe* depending on your instance requirements.
Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.
\nThis action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests,\n DescribeInstanceCreditSpecifications, DescribeVolumes,\n DescribeInstanceAttribute, and DescribeElasticGpus. Or,\n you can allow describe* depending on your instance requirements.
Retrieves the encrypted administrator password for a running Windows instance.
\nThe Windows password is generated at boot by the EC2Config service or\n EC2Launch scripts (Windows Server 2016 and later). This usually only\n happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the\n Amazon EC2 User Guide.
For the EC2Config service, the password is not generated for rebundled\n AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the\n instance. You must provide the corresponding key pair file.
\nWhen you launch an instance, password generation and encryption may take a few\n minutes. If you try to retrieve the password before it's available, the output returns\n an empty string. We recommend that you wait up to 15 minutes after launching an instance\n before trying to retrieve the generated password.
", + "smithy.api#documentation": "Retrieves the encrypted administrator password for a running Windows instance.
\nThe Windows password is generated at boot by the EC2Config service or\n EC2Launch scripts (Windows Server 2016 and later). This usually only\n happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the\n Amazon EC2 User Guide.
For the EC2Config service, the password is not generated for rebundled\n AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the\n instance. You must provide the corresponding key pair file.
\nWhen you launch an instance, password generation and encryption may take a few\n minutes. If you try to retrieve the password before it's available, the output returns\n an empty string. We recommend that you wait up to 15 minutes after launching an instance\n before trying to retrieve the generated password.
", "smithy.waiters#waitable": { "PasswordDataAvailable": { "acceptors": [ @@ -47290,7 +47288,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n reservationType - The type of reservation (prefix |\n explicit).
\n subnet-id - The ID of the subnet.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n reservationType - The type of reservation (prefix |\n explicit).
\n subnet-id - The ID of the subnet.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters. The possible values are:
\n\n resource-id - The ID of the resource.
\n resource-type - The type of resource. The valid value is: vpc.
\n state - The state of the subnet association. Valid values are\n associated | associating |\n disassociated | disassociating.
\n subnet-id - The ID of the subnet.
\n transit-gateway-attachment-id - The id of the transit gateway attachment.
One or more filters. The possible values are:
\n\n resource-id - The ID of the resource.
\n resource-type - The type of resource. The valid value is: vpc.
\n state - The state of the subnet association. Valid values are\n associated | associating |\n disassociated | disassociating.
\n subnet-id - The ID of the subnet.
\n transit-gateway-attachment-id - The id of the transit gateway attachment.
One or more filters. The possible values are:
\n\n attachment.resource-id - The ID of the resource for the attachment.
\n attachment.resource-type - The type of resource for the\n attachment. Valid values are vpc | vpn |\n direct-connect-gateway | peering.
\n attachment.transit-gateway-attachment-id - The ID of the attachment.
\n is-blackhole - Whether traffic matching the route is blocked (true | false).
\n prefix-list-id - The ID of the prefix list.
\n prefix-list-owner-id - The ID of the owner of the prefix list.
\n state - The state of the prefix list reference (pending | available | modifying | deleting).
One or more filters. The possible values are:
\n\n attachment.resource-id - The ID of the resource for the attachment.
\n attachment.resource-type - The type of resource for the\n attachment. Valid values are vpc | vpn |\n direct-connect-gateway | peering.
\n attachment.transit-gateway-attachment-id - The ID of the attachment.
\n is-blackhole - Whether traffic matching the route is blocked (true | false).
\n prefix-list-id - The ID of the prefix list.
\n prefix-list-owner-id - The ID of the owner of the prefix list.
\n state - The state of the prefix list reference (pending | available | modifying | deleting).
If you set this parameter to true, your instance is enabled for\n hibernation.
Default: false\n
If you set this parameter to true, your instance is enabled for\n hibernation.
Default: false\n
The event type.
\n\n error - An error with the Spot Fleet request.
\n fleetRequestChange - A change in the status or configuration of\n the Spot Fleet request.
\n instanceChange - An instance was launched or terminated.
\n Information - An informational event.
The event type.
\n\n error - An error with the Spot Fleet request.
\n fleetRequestChange - A change in the status or configuration of\n the Spot Fleet request.
\n instanceChange - An instance was launched or terminated.
\n Information - An informational event.
The format of the disk image being imported.
\nValid values: OVA | VHD | VHDX | VMDK | RAW \n
The format of the disk image being imported.
\nValid values: OVA | VHD | VHDX | VMDK | RAW\n
Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
\n\t\tUploading a client certificate revocation list resets existing client connections.
" + "smithy.api#documentation": "Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
\nUploading a client certificate revocation list resets existing client connections.
" } }, "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListRequest": { @@ -50801,7 +50799,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.
\nFor ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
\nFor RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.
\nFor ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
\n(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.
", + "smithy.api#documentation": "(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.
", "smithy.api#xmlName": "privateDnsName" } }, @@ -51338,7 +51336,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.
\nA Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.
", + "smithy.api#documentation": "The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.
\nA Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.
", "smithy.api#xmlName": "ipAddress" } }, @@ -52111,7 +52109,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "CpuCredits", - "smithy.api#documentation": "The credit option for CPU usage of the instance.
\nValid values: standard | unlimited\n
The credit option for CPU usage of the instance.
\nValid values: standard | unlimited\n
The credit option for CPU usage of the instance.
\nValid values: standard | unlimited\n
T3 instances with host tenancy do not support the unlimited\n CPU credit option.
The credit option for CPU usage of the instance.
\nValid values: standard | unlimited\n
T3 instances with host tenancy do not support the unlimited\n CPU credit option.
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.
Default: optional\n
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.
Default: optional\n
The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1
\nPossible values: Integers from 1 to 64
" + "smithy.api#documentation": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1
\nPossible values: Integers from 1 to 64
" } }, "HttpEndpoint": { "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", "traits": { - "smithy.api#documentation": "Enables or disables the HTTP metadata endpoint on your instances.
\nIf you specify a value of disabled, you cannot access your instance\n metadata.
Default: enabled\n
Enables or disables the HTTP metadata endpoint on your instances.
\nIf you specify a value of disabled, you cannot access your instance\n metadata.
Default: enabled\n
Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
The state of the metadata option changes.
\n\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.
\n applied - The metadata options have been successfully applied on the\n instance.
The state of the metadata option changes.
\n\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.
\n applied - The metadata options have been successfully applied on the\n instance.
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.
Default: optional\n
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.
Default: optional\n
The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1
\nPossible values: Integers from 1 to 64
", + "smithy.api#documentation": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1
\nPossible values: Integers from 1 to 64
", "smithy.api#xmlName": "httpPutResponseHopLimit" } }, @@ -52938,7 +52936,7 @@ "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", "traits": { "aws.protocols#ec2QueryName": "HttpEndpoint", - "smithy.api#documentation": "Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.
\nIf the value is disabled, you cannot access your instance\n metadata.
Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.
\nIf the value is disabled, you cannot access your instance\n metadata.
The type of network interface.
\n\tValid values: interface | efa | trunk\n
The type of network interface.
\nValid values: interface | efa | trunk\n
The position of the network interface in the attachment order. \n A primary network interface has a device index of 0.
\nIf you specify a network interface when launching an instance, \n you must specify the device index.
", + "smithy.api#documentation": "The position of the network interface in the attachment order. \n A primary network interface has a device index of 0.
\nIf you specify a network interface when launching an instance, \n you must specify the device index.
", "smithy.api#xmlName": "deviceIndex" } }, @@ -53390,7 +53388,7 @@ "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "The ID of the network interface.
\nIf you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
", + "smithy.api#documentation": "The ID of the network interface.
\nIf you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
", "smithy.api#xmlName": "networkInterfaceId" } }, @@ -53433,13 +53431,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether to assign a carrier IP address to the network interface.
\nYou can only assign a carrier IP address to a network interface that is in a subnet in\n a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer\n Guide.
" + "smithy.api#documentation": "Indicates whether to assign a carrier IP address to the network interface.
\nYou can only assign a carrier IP address to a network interface that is in a subnet in\n a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer\n Guide.
" } }, "InterfaceType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The type of network interface.
\n\tValid values: interface | efa\n
The type of network interface.
\nValid values: interface | efa\n
The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.
\nIf you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can’t specify the network card index when using this API. To specify the network\n card index, use RunInstances.
" + "smithy.api#documentation": "The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.
\nIf you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can’t specify the network card index when using this API. To specify the network\n card index, use RunInstances.
" } }, "Ipv4Prefixes": { @@ -53734,7 +53732,7 @@ "target": "com.amazonaws.ec2#AllowedInstanceTypeSet", "traits": { "aws.protocols#ec2QueryName": "AllowedInstanceTypeSet", - "smithy.api#documentation": "The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.
\nYou can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.
For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.
If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.
Default: All instance types
", + "smithy.api#documentation": "The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.
\nYou can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.
For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.
If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.
Default: All instance types
", "smithy.api#xmlName": "allowedInstanceTypeSet" } } @@ -53973,7 +53971,7 @@ "aws.protocols#ec2QueryName": "Code", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The state of the instance as a 16-bit unsigned integer.
\nThe high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values\n between 256 and 65,535. These numerical values are used for internal purposes and should\n be ignored.
\nThe low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values\n between 0 and 255.
\nThe valid values for instance-state-code will all be in the range of the low byte and\n they are:
\n\n 0 : pending\n
\n 16 : running\n
\n 32 : shutting-down\n
\n 48 : terminated\n
\n 64 : stopping\n
\n 80 : stopped\n
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in\n decimal.
", + "smithy.api#documentation": "The state of the instance as a 16-bit unsigned integer.
\nThe high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values\n between 256 and 65,535. These numerical values are used for internal purposes and should\n be ignored.
\nThe low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values\n between 0 and 255.
\nThe valid values for instance-state-code will all be in the range of the low byte and\n they are:
\n\n 0 : pending\n
\n 16 : running\n
\n 32 : shutting-down\n
\n 48 : terminated\n
\n 64 : stopping\n
\n 80 : stopped\n
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in\n decimal.
", "smithy.api#xmlName": "code" } }, @@ -54200,7 +54198,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "A description of the event.
\nAfter a scheduled event is completed, it can still be described for up to a week. If\n the event has been completed, this description starts with the following text:\n [Completed].
", + "smithy.api#documentation": "A description of the event.
\nAfter a scheduled event is completed, it can still be described for up to a week. If\n the event has been completed, this description starts with the following text:\n [Completed].
", "smithy.api#xmlName": "description" } }, @@ -58129,6 +58127,15 @@ } } }, + "com.amazonaws.ec2#InstanceTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#InstanceUsage": { "type": "structure", "members": { @@ -60300,7 +60307,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
\nFor ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
\nFor RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
\nFor ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
\nIf you used CreateKeyPair to create the key pair:
\nFor RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
\nFor ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which \n is the default for OpenSSH, starting with OpenSSH 6.8.
\nIf you used ImportKeyPair to provide Amazon Web Services the public key:
\nFor RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
\nFor ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256\n digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
\nIf you used CreateKeyPair to create the key pair:
\nFor RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
\nFor ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which \n is the default for OpenSSH, starting with OpenSSH 6.8.
\nIf you used ImportKeyPair to provide Amazon Web Services the public key:
\nFor RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
\nFor ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256\n digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
\nIf you used Amazon EC2 to create the key pair, this is the date and time when the key\n was created, in ISO\n 8601 date-time format, in the UTC time zone.
\nIf you imported an existing key pair to Amazon EC2, this is the date and time the key\n was imported, in ISO\n 8601 date-time format, in the UTC time zone.
", + "smithy.api#documentation": "If you used Amazon EC2 to create the key pair, this is the date and time when the key\n was created, in ISO\n 8601 date-time format, in the UTC time zone.
\nIf you imported an existing key pair to Amazon EC2, this is the date and time the key\n was imported, in ISO\n 8601 date-time format, in the UTC time zone.
", "smithy.api#xmlName": "createTime" } } @@ -60885,7 +60892,7 @@ "CapacityReservationPreference": { "target": "com.amazonaws.ec2#CapacityReservationPreference", "traits": { - "smithy.api#documentation": "Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:
\n\n open - The instance can run in any open Capacity\n Reservation that has matching attributes (instance type, platform, Availability\n Zone).
\n none - The instance avoids running in a Capacity Reservation even\n if one is available. The instance runs in On-Demand capacity.
Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:
\n\n open - The instance can run in any open Capacity\n Reservation that has matching attributes (instance type, platform, Availability\n Zone).
\n none - The instance avoids running in a Capacity Reservation even\n if one is available. The instance runs in On-Demand capacity.
Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:
\n\n open - The instance can run in any open Capacity\n Reservation that has matching attributes (instance type, platform, Availability\n Zone).
\n none - The instance avoids running in a Capacity Reservation even\n if one is available. The instance runs in On-Demand capacity.
Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:
\n\n open - The instance can run in any open Capacity\n Reservation that has matching attributes (instance type, platform, Availability\n Zone).
\n none - The instance avoids running in a Capacity Reservation even\n if one is available. The instance runs in On-Demand capacity.
The number of I/O operations per second (IOPS). For gp3,\n io1, and io2 volumes, this represents the number of IOPS that\n are provisioned for the volume. For gp2 volumes, this represents the\n baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
\n io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee\n 64,000 IOPS only for Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.
This parameter is supported for io1, io2, and gp3 volumes only. This parameter\n is not supported for gp2, st1, sc1, or standard volumes.
The number of I/O operations per second (IOPS). For gp3,\n io1, and io2 volumes, this represents the number of IOPS that\n are provisioned for the volume. For gp2 volumes, this represents the\n baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
\n io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee\n 64,000 IOPS only for Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.
This parameter is supported for io1, io2, and gp3 volumes only. This parameter\n is not supported for gp2, st1, sc1, or standard volumes.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. The following are the supported volumes sizes for each volume type:
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. The following are the supported volumes sizes for each volume type:
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The throughput to provision for a gp3 volume, with a maximum of 1,000\n MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
" + "smithy.api#documentation": "The throughput to provision for a gp3 volume, with a maximum of 1,000\n MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
" } } }, @@ -61172,7 +61179,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of elastic inference accelerators to attach to the instance.
\nDefault: 1
" + "smithy.api#documentation": "The number of elastic inference accelerators to attach to the instance.
\nDefault: 1
" } } }, @@ -61215,7 +61222,7 @@ "aws.protocols#ec2QueryName": "Count", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of elastic inference accelerators to attach to the instance.
\nDefault: 1
", + "smithy.api#documentation": "The number of elastic inference accelerators to attach to the instance.
\nDefault: 1
", "smithy.api#xmlName": "count" } } @@ -61334,7 +61341,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "If you set this parameter to true, the instance is enabled for\n hibernation.
Default: false\n
If you set this parameter to true, the instance is enabled for\n hibernation.
Default: false\n
The state of the metadata option changes.
\n\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.
\n applied - The metadata options have been successfully applied on the\n instance.
The state of the metadata option changes.
\n\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.
\n applied - The metadata options have been successfully applied on the\n instance.
The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1
\nPossible values: Integers from 1 to 64
", + "smithy.api#documentation": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1
\nPossible values: Integers from 1 to 64
", "smithy.api#xmlName": "httpPutResponseHopLimit" } }, @@ -61539,7 +61546,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", "traits": { "aws.protocols#ec2QueryName": "HttpEndpoint", - "smithy.api#documentation": "Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access\n your instance metadata.
Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access\n your instance metadata.
Enables or disables the IPv6 endpoint for the instance metadata service.
\nDefault: disabled\n
Enables or disables the IPv6 endpoint for the instance metadata service.
\nDefault: disabled\n
Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1\n
Possible values: Integers from 1 to 64
" + "smithy.api#documentation": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1\n
Possible values: Integers from 1 to 64
" } }, "HttpEndpoint": { "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", "traits": { - "smithy.api#documentation": "Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access\n your instance metadata.
Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access\n your instance metadata.
Enables or disables the IPv6 endpoint for the instance metadata service.
\nDefault: disabled\n
Enables or disables the IPv6 endpoint for the instance metadata service.
\nDefault: disabled\n
Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
Indicates whether to associate a Carrier IP address with eth0 for a new network\n interface.
\nUse this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.
", + "smithy.api#documentation": "Indicates whether to associate a Carrier IP address with eth0 for a new network\n interface.
\nUse this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.
", "smithy.api#xmlName": "associateCarrierIpAddress" } }, @@ -61850,7 +61857,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "Associates a Carrier IP address with eth0 for a new network interface.
\nUse this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.
" + "smithy.api#documentation": "Associates a Carrier IP address with eth0 for a new network interface.
\nUse this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.
" } }, "AssociatePublicIpAddress": { @@ -61893,7 +61900,7 @@ "InterfaceType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa. For more information, see Elastic Fabric Adapter in the\n Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA, specify interface or omit this\n parameter.
Valid values: interface | efa\n
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa. For more information, see Elastic Fabric Adapter in the\n Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA, specify interface or omit this\n parameter.
Valid values: interface | efa\n
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe priority for the launch template override. The highest priority is launched\n first.
\nIf OnDemandAllocationStrategy is set to prioritized, Spot Fleet\n uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.
If the Spot AllocationStrategy is set to\n capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.
The priority for the launch template override. The highest priority is launched\n first.
\nIf OnDemandAllocationStrategy is set to prioritized, Spot Fleet\n uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.
If the Spot AllocationStrategy is set to\n capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.
The ID of the launch template.
\nYou must specify the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The name of the launch template.
\nYou must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The launch template version number, $Latest, or\n $Default.
If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.
If the value is $Default, Amazon EC2 uses the default version of the\n launch template.
Default: The default version of the launch template.
" + "smithy.api#documentation": "The launch template version number, $Latest, or\n $Default.
If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.
If the value is $Default, Amazon EC2 uses the default version of the\n launch template.
Default: The default version of the launch template.
" } } }, @@ -62392,7 +62399,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "MaxPrice", - "smithy.api#documentation": "The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.
\nThe maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.
\nThe maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.
\nThe maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.
\nThe end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ). Supported only for\n persistent requests.
\nFor a persistent request, the request remains active until the\n ValidUntil date and time is reached. Otherwise, the request\n remains active until you cancel it.
For a one-time request, ValidUntil is not supported. The request\n remains active until all instances launch or you cancel the request.
Default: 7 days from the current date
" + "smithy.api#documentation": "The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ). Supported only for\n persistent requests.
\nFor a persistent request, the request remains active until the\n ValidUntil date and time is reached. Otherwise, the request\n remains active until you cancel it.
For a one-time request, ValidUntil is not supported. The request\n remains active until all instances launch or you cancel the request.
Default: 7 days from the current date
" } }, "InstanceInterruptionBehavior": { @@ -62514,7 +62521,7 @@ "ResourceType": { "target": "com.amazonaws.ec2#ResourceType", "traits": { - "smithy.api#documentation": "The type of resource to tag.
\nThe Valid Values are all the resource types that can be tagged. However,\n when creating a launch template, you can specify tags for the following resource types\n only: instance | volume | elastic-gpu |\n network-interface | spot-instances-request\n
To tag a resource after it has been created, see CreateTags.
" + "smithy.api#documentation": "The type of resource to tag.
\nThe Valid Values are all the resource types that can be tagged. However,\n when creating a launch template, you can specify tags for the following resource types\n only: instance | volume | elastic-gpu |\n network-interface | spot-instances-request\n
To tag a resource after it has been created, see CreateTags.
" } }, "Tags": { @@ -64344,7 +64351,7 @@ "target": "com.amazonaws.ec2#ModifyCapacityReservationFleetResult" }, "traits": { - "smithy.api#documentation": "Modifies a Capacity Reservation Fleet.
\n\t\tWhen you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically \n\t\t\tcreates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet \n\t\t\tto meet the new total target capacity. When you modify the end date for the Fleet, the end dates for \n\t\t\tall of the individual Capacity Reservations in the Fleet are updated accordingly.
" + "smithy.api#documentation": "Modifies a Capacity Reservation Fleet.
\nWhen you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically \n\t\t\tcreates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet \n\t\t\tto meet the new total target capacity. When you modify the end date for the Fleet, the end dates for \n\t\t\tall of the individual Capacity Reservations in the Fleet are updated accordingly.
" } }, "com.amazonaws.ec2#ModifyCapacityReservationFleetRequest": { @@ -64369,7 +64376,7 @@ "EndDate": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "smithy.api#documentation": "The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation \n\t\t\tFleet expires, its state changes to expired and all of the Capacity Reservations in the \n\t\t\tFleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you \n\t\t\tspecify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed \n\t\t\tto expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can't specify EndDate and \n\t\t\tRemoveEndDate in the same request.
" + "smithy.api#documentation": "The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation \n\t\t\tFleet expires, its state changes to expired and all of the Capacity Reservations in the \n\t\t\tFleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you \n\t\t\tspecify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed \n\t\t\tto expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can't specify EndDate and \n\t\t\tRemoveEndDate in the same request.
" } }, "DryRun": { @@ -64385,7 +64392,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the \n\t\t\tend date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly \n\t\t\tcancel it using the CancelCapacityReservationFleet action.
\n\t\tYou can't specify RemoveEndDate and \n\t\t\tEndDate in the same request.
" + "smithy.api#documentation": "Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the \n\t\t\tend date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly \n\t\t\tcancel it using the CancelCapacityReservationFleet action.
\nYou can't specify RemoveEndDate and \n\t\t\tEndDate in the same request.
" } } } @@ -64427,13 +64434,13 @@ "EndDate": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
\n\t\tYou must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
\nYou must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:
\n\t\t\n unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not\n\t\t\t\t\tprovide an EndDate value if EndDateType is\n\t\t\t\t\t\tunlimited.
\n limited - The Capacity Reservation expires automatically at a specified date and time. You must\n\t\t\t\t\tprovide an EndDate value if EndDateType is\n\t\t\t\t\t\tlimited.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:
\n\n unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not\n\t\t\t\t\tprovide an EndDate value if EndDateType is\n\t\t\t\t\t\tunlimited.
\n limited - The Capacity Reservation expires automatically at a specified date and time. You must\n\t\t\t\t\tprovide an EndDate value if EndDateType is\n\t\t\t\t\t\tlimited.
Information about the client connection logging options.
\n\t\tIf you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:
\n\t\tClient connection requests
\nClient connection results (successful and unsuccessful)
\nReasons for unsuccessful client connection requests
\nClient connection termination time
\nInformation about the client connection logging options.
\nIf you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:
\nClient connection requests
\nClient connection results (successful and unsuccessful)
\nReasons for unsuccessful client connection requests
\nClient connection termination time
\nThe port number to assign to the Client VPN endpoint for TCP and UDP traffic.
\n\tValid Values: 443 | 1194\n
Default Value: 443\n
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
\nValid Values: 443 | 1194\n
Default Value: 443\n
Indicates whether the VPN is split-tunnel.
\nFor information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n \tClient VPN Administrator Guide.
" + "smithy.api#documentation": "Indicates whether the VPN is split-tunnel.
\nFor information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n \tClient VPN Administrator Guide.
" } }, "DryRun": { @@ -64576,7 +64583,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The maximum VPN session duration time in hours.
\n\t\tValid values: 8 | 10 | 12 | 24\n
Default value: 24\n
The maximum VPN session duration time in hours.
\nValid values: 8 | 10 | 12 | 24\n
Default value: 24\n
Modifies the default credit option for CPU usage of burstable performance instances.\n The default credit option is set at the account level per Amazon Web Services Region, and\n is specified per instance family. All new burstable performance instances in the account\n launch using the default credit option.
\n\n ModifyDefaultCreditSpecification is an asynchronous operation, which\n works at an Amazon Web Services Region level and modifies the credit option for each\n Availability Zone. All zones in a Region are updated within five minutes. But if\n instances are launched during this operation, they might not get the new credit option\n until the zone is updated. To verify whether the update has occurred, you can call\n GetDefaultCreditSpecification and check\n DefaultCreditSpecification for updates.
For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Modifies the default credit option for CPU usage of burstable performance instances.\n The default credit option is set at the account level per Amazon Web Services Region, and\n is specified per instance family. All new burstable performance instances in the account\n launch using the default credit option.
\n\n ModifyDefaultCreditSpecification is an asynchronous operation, which\n works at an Amazon Web Services Region level and modifies the credit option for each\n Availability Zone. All zones in a Region are updated within five minutes. But if\n instances are launched during this operation, they might not get the new credit option\n until the zone is updated. To verify whether the update has occurred, you can call\n GetDefaultCreditSpecification and check\n DefaultCreditSpecification for updates.
For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ModifyDefaultCreditSpecificationRequest": { @@ -64637,7 +64644,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The credit option for CPU usage of the instance family.
\nValid Values: standard | unlimited\n
The credit option for CPU usage of the instance family.
\nValid Values: standard | unlimited\n
Changes the default KMS key for EBS encryption by default for your account in this Region.
\n \tAmazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If\n you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services\n managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.
\nIf you delete or disable the customer managed KMS key that you specified for use with\n encryption by default, your instances will fail to launch.
\nFor more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Changes the default KMS key for EBS encryption by default for your account in this Region.
\nAmazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If\n you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services\n managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.
\nIf you delete or disable the customer managed KMS key that you specified for use with\n encryption by default, your instances will fail to launch.
\nFor more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdRequest": { @@ -64675,7 +64682,7 @@ "target": "com.amazonaws.ec2#KmsKeyId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.
\nAmazon EBS does not support asymmetric KMS keys.
", + "smithy.api#documentation": "The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.
\nAmazon EBS does not support asymmetric KMS keys.
", "smithy.api#required": {} } }, @@ -64881,7 +64888,7 @@ "target": "com.amazonaws.ec2#ModifyHostsResult" }, "traits": { - "smithy.api#documentation": "Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled,\n any instances that you launch with a tenancy of host but without a specific\n host ID are placed onto any available Dedicated Host in your account that has\n auto-placement enabled. When auto-placement is disabled, you need to provide a host ID\n to have the instance launch onto a specific host. If no host ID is provided, the\n instance is launched onto a suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple\n instance types in an instance family, or to support a specific instance type\n only.
" + "smithy.api#documentation": "Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled,\n any instances that you launch with a tenancy of host but without a specific\n host ID are placed onto any available Dedicated Host in your account that has\n auto-placement enabled. When auto-placement is disabled, you need to provide a host ID\n to have the instance launch onto a specific host. If no host ID is provided, the\n instance is launched onto a suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple\n instance types in an instance family, or to support a specific instance type\n only.
" } }, "com.amazonaws.ec2#ModifyHostsRequest": { @@ -64914,13 +64921,13 @@ "InstanceType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Specifies the instance type to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support only a specific instance type.
\n\nIf you want to modify a Dedicated Host to support multiple instance types in its\n current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.
" + "smithy.api#documentation": "Specifies the instance type to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support only a specific instance type.
\nIf you want to modify a Dedicated Host to support multiple instance types in its\n current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.
" } }, "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Specifies the instance family to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support multiple instance types within its\n current instance family.
\n\nIf you want to modify a Dedicated Host to support a specific instance type only, omit\n this parameter and specify InstanceType instead. You\n cannot specify InstanceFamily and InstanceType in the same request.
" + "smithy.api#documentation": "Specifies the instance family to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support multiple instance types within its\n current instance family.
\nIf you want to modify a Dedicated Host to support a specific instance type only, omit\n this parameter and specify InstanceType instead. You\n cannot specify InstanceFamily and InstanceType in the same request.
" } } } @@ -64989,7 +64996,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account. You can\n specify that resources should receive longer IDs (17-character IDs) when they are created.
\nThis request can only be used to modify longer ID settings for resource types that are\n within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
For more information, see Resource IDs in the\n Amazon Elastic Compute Cloud User Guide.
\nThis setting applies to the principal specified in the request; it does not apply to the\n principal that makes the request.
\nResources created with longer IDs are visible to all IAM roles and users, regardless of these\n settings and provided that they have permission to use the relevant Describe\n command for the resource type.
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account. You can\n specify that resources should receive longer IDs (17-character IDs) when they are created.
\nThis request can only be used to modify longer ID settings for resource types that are\n within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
For more information, see Resource IDs in the\n Amazon Elastic Compute Cloud User Guide.
\nThis setting applies to the principal specified in the request; it does not apply to the\n principal that makes the request.
\nResources created with longer IDs are visible to all IAM roles and users, regardless of these\n settings and provided that they have permission to use the relevant Describe\n command for the resource type.
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.\n You can use the Attribute parameter to specify the attribute or one of the following parameters: \n Description or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
\nTo enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.
" + "smithy.api#documentation": "Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.\n You can use the Attribute parameter to specify the attribute or one of the following parameters: \n Description or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
\nTo enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.
" } }, "com.amazonaws.ec2#ModifyImageAttributeRequest": { @@ -65140,7 +65147,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.
\n\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance in a VPC can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.
\nTo modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.
\n\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance in a VPC can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.
\nTo modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ModifyInstanceAttributeRequest": { @@ -65156,7 +65163,7 @@ "target": "com.amazonaws.ec2#InstanceAttributeName", "traits": { "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#documentation": "The name of the attribute to modify.
\nYou can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n
The name of the attribute to modify.
\nYou can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n
Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "blockDeviceMapping" } }, @@ -65198,7 +65205,7 @@ "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "Set to true to enable enhanced networking with ENA for the\n instance.
This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.
", + "smithy.api#documentation": "Set to true to enable enhanced networking with ENA for the\n instance.
This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.
", "smithy.api#xmlName": "enaSupport" } }, @@ -65255,7 +65262,7 @@ "target": "com.amazonaws.ec2#AttributeValue", "traits": { "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.
\nThis option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.
", + "smithy.api#documentation": "Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.
\nThis option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.
", "smithy.api#xmlName": "sriovNetSupport" } }, @@ -65278,7 +65285,7 @@ "DisableApiStop": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "smithy.api#documentation": "Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n Protection.
\n " + "smithy.api#documentation": "Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n Protection.
\n " } } } @@ -65348,7 +65355,7 @@ "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecificationResult" }, "traits": { - "smithy.api#documentation": "Modifies the credit option for CPU usage on a running or stopped burstable performance\n instance. The credit options are standard and\n unlimited.
For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Modifies the credit option for CPU usage on a running or stopped burstable performance\n instance. The credit options are standard and\n unlimited.
For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ModifyInstanceCreditSpecificationRequest": { @@ -65613,7 +65620,7 @@ "HttpTokens": { "target": "com.amazonaws.ec2#HttpTokensState", "traits": { - "smithy.api#documentation": "The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.
The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel. If no parameter is specified,\n the existing state is maintained.
\nPossible values: Integers from 1 to 64
" + "smithy.api#documentation": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel. If no parameter is specified,\n the existing state is maintained.
\nPossible values: Integers from 1 to 64
" } }, "HttpEndpoint": { "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", "traits": { - "smithy.api#documentation": "Enables or disables the HTTP metadata endpoint on your instances. If this parameter is\n not specified, the existing state is maintained.
\nIf you specify a value of disabled, you cannot access your instance\n metadata.
Enables or disables the HTTP metadata endpoint on your instances. If this parameter is\n not specified, the existing state is maintained.
\nIf you specify a value of disabled, you cannot access your instance\n metadata.
Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
Modifies the placement attributes for a specified instance. You can do the\n following:
\nModify the affinity between an instance and a Dedicated\n Host. When affinity is set to host and the instance is\n not associated with a specific Dedicated Host, the next time the instance is\n launched, it is automatically associated with the host on which it lands. If the\n instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
\nChange the instance tenancy of an instance.
\nMove an instance to or from a placement\n group.
\nAt least one attribute for affinity, host ID, tenancy, or placement group name must be\n specified in the request. Affinity and tenancy can be modified in the same\n request.
\nTo modify the host ID, tenancy, placement group, or partition for an instance, the\n instance must be in the stopped state.
Modifies the placement attributes for a specified instance. You can do the\n following:
\nModify the affinity between an instance and a Dedicated\n Host. When affinity is set to host and the instance is\n not associated with a specific Dedicated Host, the next time the instance is\n launched, it is automatically associated with the host on which it lands. If the\n instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
\nChange the instance tenancy of an instance.
\nMove an instance to or from a placement\n group.
\nAt least one attribute for affinity, host ID, tenancy, or placement group name must be\n specified in the request. Affinity and tenancy can be modified in the same\n request.
\nTo modify the host ID, tenancy, placement group, or partition for an instance, the\n instance must be in the stopped state.
The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.
To remove an instance from a placement group, specify an empty string (\"\").
" + "smithy.api#documentation": "The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.
To remove an instance from a placement group, specify an empty string (\"\").
" } }, "HostId": { @@ -65724,7 +65731,7 @@ "target": "com.amazonaws.ec2#HostTenancy", "traits": { "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "The tenancy for the instance.
\n\nFor T3 instances, you can't change the tenancy from dedicated to\n host, or from host to dedicated.\n Attempting to make one of these unsupported tenancy changes results in the\n InvalidTenancy error code.
The tenancy for the instance.
\nFor T3 instances, you can't change the tenancy from dedicated to\n host, or from host to dedicated.\n Attempting to make one of these unsupported tenancy changes results in the\n InvalidTenancy error code.
Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
" + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
" } }, "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The name of the launch template.
\nYou must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
Modifies the specified managed prefix list.
\nAdding or removing entries in a prefix list creates a new version of the prefix list.\n Changing the name of the prefix list does not affect the version.
\nIf you specify a current version number that does not match the true current version\n number, the request fails.
" + "smithy.api#documentation": "Modifies the specified managed prefix list.
\nAdding or removing entries in a prefix list creates a new version of the prefix list.\n Changing the name of the prefix list does not affect the version.
\nIf you specify a current version number that does not match the true current version\n number, the request fails.
" } }, "com.amazonaws.ec2#ModifyManagedPrefixListRequest": { @@ -66267,7 +66274,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of entries for the prefix list. You cannot modify the entries \n of a prefix list and modify the size of a prefix list at the same time.
\nIf any of the resources that reference the prefix list cannot support the new\n maximum size, the modify operation fails. Check the state message for the IDs of \n the first ten resources that do not support the new maximum size.
" + "smithy.api#documentation": "The maximum number of entries for the prefix list. You cannot modify the entries \n of a prefix list and modify the size of a prefix list at the same time.
\nIf any of the resources that reference the prefix list cannot support the new\n maximum size, the modify operation fails. Check the state message for the IDs of \n the first ten resources that do not support the new maximum size.
" } } } @@ -66439,7 +66446,7 @@ "target": "com.amazonaws.ec2#ModifyReservedInstancesResult" }, "traits": { - "smithy.api#documentation": "Modifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.
\n\t\tFor more information, see Modifying Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nModifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.
\nFor more information, see Modifying Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nModifies the specified Spot Fleet request.
\nYou can only modify a Spot Fleet request of type maintain.
While the Spot Fleet request is being modified, it is in the modifying\n state.
To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the\n additional Spot Instances according to the allocation strategy for the Spot Fleet\n request. If the allocation strategy is lowestPrice, the Spot Fleet launches\n instances using the Spot Instance pool with the lowest price. If the allocation strategy\n is diversified, the Spot Fleet distributes the instances across the Spot\n Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching.
To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet\n cancels any open requests that exceed the new target capacity. You can request that the\n Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the\n new target capacity. If the allocation strategy is lowestPrice, the Spot\n Fleet terminates the instances with the highest price per unit. If the allocation\n strategy is capacityOptimized, the Spot Fleet terminates the instances in\n the Spot Instance pools that have the least available Spot Instance capacity. If the allocation\n strategy is diversified, the Spot Fleet terminates instances across the\n Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet\n at its current size, but not replace any Spot Instances that are interrupted or that you\n terminate manually.
If you are finished with your Spot Fleet for now, but will use it again later, you can\n set the target capacity to 0.
" + "smithy.api#documentation": "Modifies the specified Spot Fleet request.
\nYou can only modify a Spot Fleet request of type maintain.
While the Spot Fleet request is being modified, it is in the modifying\n state.
To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the\n additional Spot Instances according to the allocation strategy for the Spot Fleet\n request. If the allocation strategy is lowestPrice, the Spot Fleet launches\n instances using the Spot Instance pool with the lowest price. If the allocation strategy\n is diversified, the Spot Fleet distributes the instances across the Spot\n Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching.
To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet\n cancels any open requests that exceed the new target capacity. You can request that the\n Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the\n new target capacity. If the allocation strategy is lowestPrice, the Spot\n Fleet terminates the instances with the highest price per unit. If the allocation\n strategy is capacityOptimized, the Spot Fleet terminates the instances in\n the Spot Instance pools that have the least available Spot Instance capacity. If the allocation\n strategy is diversified, the Spot Fleet terminates instances across the\n Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet\n at its current size, but not replace any Spot Instances that are interrupted or that you\n terminate manually.
If you are finished with your Spot Fleet for now, but will use it again later, you can\n set the target capacity to 0.
" } }, "com.amazonaws.ec2#ModifySpotFleetRequestRequest": { @@ -66772,7 +66779,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Modifies a subnet attribute. You can only modify one attribute at a time.
\n\t \n\tUse this action to modify subnets on Amazon Web Services Outposts.
\nTo modify a subnet on an Outpost rack, set both\n MapCustomerOwnedIpOnLaunch and\n CustomerOwnedIpv4Pool. These two parameters act as a single\n attribute.
To modify a subnet on an Outpost server, set either\n EnableLniAtDeviceIndex or\n DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
\n\t \n\t\n Outpost servers\n
\n\n Outpost racks\n
\nModifies a subnet attribute. You can only modify one attribute at a time.
\nUse this action to modify subnets on Amazon Web Services Outposts.
\nTo modify a subnet on an Outpost rack, set both\n MapCustomerOwnedIpOnLaunch and\n CustomerOwnedIpv4Pool. These two parameters act as a single\n attribute.
To modify a subnet on an Outpost server, set either\n EnableLniAtDeviceIndex or\n DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
\n\n Outpost servers\n
\n\n Outpost racks\n
\nSpecify true to indicate that network interfaces created in the\n specified subnet should be assigned an IPv6 address. This includes a network interface\n that's created when launching an instance into the subnet (the instance therefore\n receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface\n or instance only receives an IPv6 address if it's created using version\n 2016-11-15 or later of the Amazon EC2 API.
Specify true to indicate that network interfaces created in the\n specified subnet should be assigned an IPv6 address. This includes a network interface\n that's created when launching an instance into the subnet (the instance therefore\n receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface\n or instance only receives an IPv6 address if it's created using version\n 2016-11-15 or later of the Amazon EC2 API.
Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
The customer-owned IPv4 address pool associated with the subnet.
\nYou must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
The customer-owned IPv4 address pool associated with the subnet.
\nYou must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
\nThe modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.
" + "smithy.api#documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
\nThe modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.
" } } }, @@ -68060,7 +68067,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. \n The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3.\n Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
" + "smithy.api#documentation": "The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. \n The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3.\n Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
" } }, "MultiAttachEnabled": { @@ -68327,7 +68334,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult" }, "traits": { - "smithy.api#documentation": "Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.
\n\tIf you set or modify the private DNS name, you must prove that you own the private DNS\n domain name.
" + "smithy.api#documentation": "Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.
\nIf you set or modify the private DNS name, you must prove that you own the private DNS\n domain name.
" } }, "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest": { @@ -68495,7 +68502,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult" }, "traits": { - "smithy.api#documentation": "Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers \n\t (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.
\n\tIf you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.
" + "smithy.api#documentation": "Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers \n\t (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.
\nIf you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.
" } }, "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest": { @@ -68629,7 +68636,7 @@ "target": "com.amazonaws.ec2#ModifyVpcTenancyResult" }, "traits": { - "smithy.api#documentation": "Modifies the instance tenancy attribute of the specified VPC. You can change the\n instance tenancy attribute of a VPC to default only. You cannot change the\n instance tenancy attribute to dedicated.
After you modify the tenancy of the VPC, any new instances that you launch into the\n VPC have a tenancy of default, unless you specify otherwise during launch.\n The tenancy of any existing instances in the VPC is not affected.
For more information, see Dedicated Instances in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Modifies the instance tenancy attribute of the specified VPC. You can change the\n instance tenancy attribute of a VPC to default only. You cannot change the\n instance tenancy attribute to dedicated.
After you modify the tenancy of the VPC, any new instances that you launch into the\n VPC have a tenancy of default, unless you specify otherwise during launch.\n The tenancy of any existing instances in the VPC is not affected.
For more information, see Dedicated Instances in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#ModifyVpcTenancyRequest": { @@ -68685,7 +68692,7 @@ "target": "com.amazonaws.ec2#ModifyVpnConnectionResult" }, "traits": { - "smithy.api#documentation": "Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To\n modify the target gateway, the following migration options are available:
\nAn existing virtual private gateway to a new virtual private gateway
\nAn existing virtual private gateway to a transit gateway
\nAn existing transit gateway to a new transit gateway
\nAn existing transit gateway to a virtual private gateway
\nBefore you perform the migration to the new gateway, you must configure the new\n gateway. Use CreateVpnGateway to create a virtual private gateway, or\n CreateTransitGateway to create a transit gateway.
\nThis step is required when you migrate from a virtual private gateway with static\n routes to a transit gateway.
\nYou must delete the static routes before you migrate to the new gateway.
\n\nKeep a copy of the static route before you delete it. You will need to add back these\n routes to the transit gateway after the VPN connection migration is complete.
\n\nAfter you migrate to the new gateway, you might need to modify your VPC route table.\n Use CreateRoute and DeleteRoute to make the changes\n described in Update VPC route\n tables in the Amazon Web Services Site-to-Site VPN User Guide.
\nWhen the new gateway is a transit gateway, modify the transit gateway route table to\n allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection.\n Use CreateTransitGatewayRoute to add the routes.
\nIf you deleted VPN static routes, you must add the static routes to the transit\n gateway route table.
\nAfter you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will\n be temporarily unavailable for a brief period while we provision the new\n endpoints.
" + "smithy.api#documentation": "Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To\n modify the target gateway, the following migration options are available:
\nAn existing virtual private gateway to a new virtual private gateway
\nAn existing virtual private gateway to a transit gateway
\nAn existing transit gateway to a new transit gateway
\nAn existing transit gateway to a virtual private gateway
\nBefore you perform the migration to the new gateway, you must configure the new\n gateway. Use CreateVpnGateway to create a virtual private gateway, or\n CreateTransitGateway to create a transit gateway.
\nThis step is required when you migrate from a virtual private gateway with static\n routes to a transit gateway.
\nYou must delete the static routes before you migrate to the new gateway.
\nKeep a copy of the static route before you delete it. You will need to add back these\n routes to the transit gateway after the VPN connection migration is complete.
\nAfter you migrate to the new gateway, you might need to modify your VPC route table.\n Use CreateRoute and DeleteRoute to make the changes\n described in Update VPC route\n tables in the Amazon Web Services Site-to-Site VPN User Guide.
\nWhen the new gateway is a transit gateway, modify the transit gateway route table to\n allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection.\n Use CreateTransitGatewayRoute to add the routes.
\nIf you deleted VPN static routes, you must add the static routes to the transit\n gateway route table.
\nAfter you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will\n be temporarily unavailable for a brief period while we provision the new\n endpoints.
" } }, "com.amazonaws.ec2#ModifyVpnConnectionOptions": { @@ -68697,7 +68704,7 @@ "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult" }, "traits": { - "smithy.api#documentation": "Modifies the connection options for your Site-to-Site VPN connection.
\nWhen you modify the VPN connection options, the VPN endpoint IP addresses on the\n Amazon Web Services side do not change, and the tunnel options do not change. Your\n VPN connection will be temporarily unavailable for a brief period while the VPN\n connection is updated.
" + "smithy.api#documentation": "Modifies the connection options for your Site-to-Site VPN connection.
\nWhen you modify the VPN connection options, the VPN endpoint IP addresses on the\n Amazon Web Services side do not change, and the tunnel options do not change. Your\n VPN connection will be temporarily unavailable for a brief period while the VPN\n connection is updated.
" } }, "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest": { @@ -68714,25 +68721,25 @@ "LocalIpv4NetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
\nDefault: 0.0.0.0/0\n
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
\nDefault: 0.0.0.0/0\n
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
\nDefault: 0.0.0.0/0\n
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
\nDefault: 0.0.0.0/0\n
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
\nDefault: ::/0\n
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
\nDefault: ::/0\n
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
\nDefault: ::/0\n
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
\nDefault: ::/0\n
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.
\nConstraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:
\n 169.254.0.0/30\n
\n 169.254.1.0/30\n
\n 169.254.2.0/30\n
\n 169.254.3.0/30\n
\n 169.254.4.0/30\n
\n 169.254.5.0/30\n
\n 169.254.169.252/30\n
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.
\nConstraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:
\n 169.254.0.0/30\n
\n 169.254.1.0/30\n
\n 169.254.2.0/30\n
\n 169.254.3.0/30\n
\n 169.254.4.0/30\n
\n 169.254.5.0/30\n
\n 169.254.169.252/30\n
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.
\nConstraints: A size /126 CIDR block from the local fd00::/8 range.
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.
\nConstraints: A size /126 CIDR block from the local fd00::/8 range.
The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.
\nConstraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).
" + "smithy.api#documentation": "The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.
\nConstraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).
" } }, "Phase1LifetimeSeconds": { @@ -68952,7 +68959,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The lifetime for phase 1 of the IKE negotiation, in seconds.
\nConstraints: A value between 900 and 28,800.
\nDefault: 28800\n
The lifetime for phase 1 of the IKE negotiation, in seconds.
\nConstraints: A value between 900 and 28,800.
\nDefault: 28800\n
The lifetime for phase 2 of the IKE negotiation, in seconds.
\nConstraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.
Default: 3600\n
The lifetime for phase 2 of the IKE negotiation, in seconds.
\nConstraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.
Default: 3600\n
The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540\n
The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540\n
The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
\nDefault: 100\n
The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
\nDefault: 100\n
The number of packets in an IKE replay window.
\nConstraints: A value between 64 and 2048.
\nDefault: 1024\n
The number of packets in an IKE replay window.
\nConstraints: A value between 64 and 2048.
\nDefault: 1024\n
The number of seconds after which a DPD timeout occurs.
\nConstraints: A value greater than or equal to 30.
\nDefault: 30\n
The number of seconds after which a DPD timeout occurs.
\nConstraints: A value greater than or equal to 30.
\nDefault: 30\n
The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart\n
Default: clear\n
The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart\n
Default: clear\n
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.
\nValid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.
\nValid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.
\nValid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.
\nValid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.
\nValid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.
\nValid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.
\nValid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.
\nValid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.
\nValid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.
\nValid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.
\nValid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.
\nValid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n
The IKE versions that are permitted for the VPN tunnel.
\nValid values: ikev1 | ikev2\n
The IKE versions that are permitted for the VPN tunnel.
\nValid values: ikev1 | ikev2\n
The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.
Valid Values: add | start\n
Default: add\n
The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.
Valid Values: add | start\n
Default: add\n
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is\n enabled. For more information, see Monitor your instances using\n CloudWatch in the Amazon EC2 User Guide.
\nTo disable detailed monitoring, see UnmonitorInstances.
" + "smithy.api#documentation": "Enables detailed monitoring for a running instance. Otherwise, basic monitoring is\n enabled. For more information, see Monitor your instances using\n CloudWatch in the Amazon EC2 User Guide.
\nTo disable detailed monitoring, see UnmonitorInstances.
" } }, "com.amazonaws.ec2#MonitorInstancesRequest": { @@ -70782,7 +70789,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "CarrierIp", - "smithy.api#documentation": "The carrier IP address associated with the network interface.
\nThis option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
", + "smithy.api#documentation": "The carrier IP address associated with the network interface.
\nThis option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
", "smithy.api#xmlName": "carrierIp" } } @@ -72640,7 +72647,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "The Availability Zone of the instance.
\nIf not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.
\nThis parameter is not supported for CreateFleet.
", + "smithy.api#documentation": "The Availability Zone of the instance.
\nIf not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.
\nThis parameter is not supported for CreateFleet.
", "smithy.api#xmlName": "availabilityZone" } }, @@ -72648,7 +72655,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Affinity", - "smithy.api#documentation": "The affinity setting for the instance on the Dedicated Host.
\nThis parameter is not supported for CreateFleet or ImportInstance.
", + "smithy.api#documentation": "The affinity setting for the instance on the Dedicated Host.
\nThis parameter is not supported for CreateFleet or ImportInstance.
", "smithy.api#xmlName": "affinity" } }, @@ -72666,7 +72673,7 @@ "aws.protocols#ec2QueryName": "PartitionNumber", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of the partition that the instance is in. Valid only if the placement group\n strategy is set to partition.
This parameter is not supported for CreateFleet.
", + "smithy.api#documentation": "The number of the partition that the instance is in. Valid only if the placement group\n strategy is set to partition.
This parameter is not supported for CreateFleet.
", "smithy.api#xmlName": "partitionNumber" } }, @@ -72674,7 +72681,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "The ID of the Dedicated Host on which the instance resides.
\nThis parameter is not supported for CreateFleet or ImportInstance.
", + "smithy.api#documentation": "The ID of the Dedicated Host on which the instance resides.
\nThis parameter is not supported for CreateFleet or ImportInstance.
", "smithy.api#xmlName": "hostId" } }, @@ -72682,7 +72689,7 @@ "target": "com.amazonaws.ec2#Tenancy", "traits": { "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware.
This parameter is not supported for CreateFleet. The\n host tenancy is not supported for ImportInstance or\n for T3 instances that are configured for the unlimited CPU credit\n option.
The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware.
This parameter is not supported for CreateFleet. The\n host tenancy is not supported for ImportInstance or\n for T3 instances that are configured for the unlimited CPU credit\n option.
The ARN of the host resource group in which to launch the instances.
\nIf you specify this parameter, either omit the Tenancy parameter or set it to host.
This parameter is not supported for CreateFleet.
", + "smithy.api#documentation": "The ARN of the host resource group in which to launch the instances.
\nIf you specify this parameter, either omit the Tenancy parameter or set it to host.
This parameter is not supported for CreateFleet.
", "smithy.api#xmlName": "hostResourceGroupArn" } }, @@ -73525,7 +73532,7 @@ "target": "com.amazonaws.ec2#DnsNameState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "The verification state of the VPC endpoint service.
\n>Consumers\n of the endpoint service can use the private name only when the state is\n verified.
The verification state of the VPC endpoint service.
\n>Consumers\n of the endpoint service can use the private name only when the state is\n verified.
(IPv6 only) Indicate whether the address range will be publicly advertised to the\n internet.
\nDefault: true
" + "smithy.api#documentation": "(IPv6 only) Indicate whether the address range will be publicly advertised to the\n internet.
\nDefault: true
" } }, "Description": { @@ -74533,7 +74540,7 @@ "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult" }, "traits": { - "smithy.api#documentation": "Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.
\n\t\tUse DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.
\nTo queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.
\n \tFor more information, see Reserved Instances and \n \t Reserved Instance Marketplace \n \t in the Amazon EC2 User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nPurchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.
\nUse DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.
\nTo queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.
\nFor more information, see Reserved Instances and \n \t Reserved Instance Marketplace \n \t in the Amazon EC2 User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nRequests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.
\nIf an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.
\nFor more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.
\nIf an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.
\nFor more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#RebootInstancesRequest": { @@ -74911,7 +74918,7 @@ "target": "com.amazonaws.ec2#RegisterImageResult" }, "traits": { - "smithy.api#documentation": "Registers an AMI. When you're creating an AMI, this is the final step you must complete\n before you can launch an instance from the AMI. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.
\nFor Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.
\nIf needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. \n If you make changes to an image, deregister the previous image and register the new image.
\n\n\n Register a snapshot of a root device volume\n
\n \tYou can use RegisterImage to create an Amazon EBS-backed Linux AMI from\n a snapshot of a root device volume. You specify the snapshot using a block device mapping.\n You can't set the encryption state of the volume using the block device mapping. If the \n snapshot is encrypted, or encryption by default is enabled, the root volume of an instance \n launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs\n in the Amazon Elastic Compute Cloud User Guide.
\n \n \t\n Amazon Web Services Marketplace product codes\n
\n \tIf any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new\n AMI.
\nWindows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:
\nLaunch an instance from an existing AMI with that billing product code.
\nCustomize the instance.
\nCreate an AMI from the instance using CreateImage.
\nIf you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Registers an AMI. When you're creating an AMI, this is the final step you must complete\n before you can launch an instance from the AMI. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.
\nFor Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.
\nIf needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. \n If you make changes to an image, deregister the previous image and register the new image.
\n\n Register a snapshot of a root device volume\n
\nYou can use RegisterImage to create an Amazon EBS-backed Linux AMI from\n a snapshot of a root device volume. You specify the snapshot using a block device mapping.\n You can't set the encryption state of the volume using the block device mapping. If the \n snapshot is encrypted, or encryption by default is enabled, the root volume of an instance \n launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs\n in the Amazon Elastic Compute Cloud User Guide.
\n\n Amazon Web Services Marketplace product codes\n
\nIf any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new\n AMI.
\nWindows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:
\nLaunch an instance from an existing AMI with that billing product code.
\nCustomize the instance.
\nCreate an AMI from the instance using CreateImage.
\nIf you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#RegisterImageRequest": { @@ -74927,14 +74934,14 @@ "target": "com.amazonaws.ec2#ArchitectureValues", "traits": { "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "The architecture of the AMI.
\n \tDefault: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.
The architecture of the AMI.
\nDefault: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
\n \tIf you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
\nIf you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region \n \t of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost \n \t only. For more information, \n \t \tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "The block device mapping entries.
\nIf you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
\nIf you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region \n \t of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost \n \t only. For more information, \n \t \tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
", "smithy.api#xmlName": "BlockDeviceMapping" } }, @@ -75144,7 +75151,7 @@ "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersResult" }, "traits": { - "smithy.api#documentation": "Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated\n with a supported EC2 instance that receives multicast traffic. For information about\n supported instances, see Multicast\n Consideration in Amazon VPC Transit Gateways.
\nAfter you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added\n to the transit gateway multicast group.
" + "smithy.api#documentation": "Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated\n with a supported EC2 instance that receives multicast traffic. For information about\n supported instances, see Multicast\n Consideration in Amazon VPC Transit Gateways.
\nAfter you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added\n to the transit gateway multicast group.
" } }, "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest": { @@ -75200,7 +75207,7 @@ "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesResult" }, "traits": { - "smithy.api#documentation": "Registers sources (network interfaces) with the specified transit gateway multicast group.
\nA multicast source is a network interface attached to a supported instance that sends\n multicast traffic. For information about supported instances, see Multicast\n Considerations in Amazon VPC Transit Gateways.
\nAfter you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast\n group.
" + "smithy.api#documentation": "Registers sources (network interfaces) with the specified transit gateway multicast group.
\nA multicast source is a network interface attached to a supported instance that sends\n multicast traffic. For information about supported instances, see Multicast\n Considerations in Amazon VPC Transit Gateways.
\nAfter you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast\n group.
" } }, "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesRequest": { @@ -75556,7 +75563,7 @@ "target": "com.amazonaws.ec2#ReleaseHostsResult" }, "traits": { - "smithy.api#documentation": "When you no longer want to use an On-Demand Dedicated Host it can be released.\n On-Demand billing is stopped and the host goes into released state. The\n host ID of Dedicated Hosts that have been released can no longer be specified in another\n request, for example, to modify the host. You must stop or terminate all instances on a\n host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting\n toward your limit and you may receive capacity errors when trying to allocate new\n Dedicated Hosts. Wait a few minutes and then try again.
\nReleased hosts still appear in a DescribeHosts response.
" + "smithy.api#documentation": "When you no longer want to use an On-Demand Dedicated Host it can be released.\n On-Demand billing is stopped and the host goes into released state. The\n host ID of Dedicated Hosts that have been released can no longer be specified in another\n request, for example, to modify the host. You must stop or terminate all instances on a\n host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting\n toward your limit and you may receive capacity errors when trying to allocate new\n Dedicated Hosts. Wait a few minutes and then try again.
\nReleased hosts still appear in a DescribeHosts response.
" } }, "com.amazonaws.ec2#ReleaseHostsRequest": { @@ -75722,7 +75729,7 @@ "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationResult" }, "traits": { - "smithy.api#documentation": "Replaces an IAM instance profile for the specified running instance. You can use\n this action to change the IAM instance profile that's associated with an instance\n without having to disassociate the existing IAM instance profile first.
\nUse DescribeIamInstanceProfileAssociations to get the association\n ID.
" + "smithy.api#documentation": "Replaces an IAM instance profile for the specified running instance. You can use\n this action to change the IAM instance profile that's associated with an instance\n without having to disassociate the existing IAM instance profile first.
\nUse DescribeIamInstanceProfileAssociations to get the association\n ID.
" } }, "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationRequest": { @@ -75768,7 +75775,7 @@ "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociationResult" }, "traits": { - "smithy.api#documentation": "Changes which network ACL a subnet is associated with. By default when you create a\n\t\t\tsubnet, it's automatically associated with the default network ACL. For more\n\t\t\tinformation, see Network\n\t\t\tACLs in the Amazon Virtual Private Cloud User Guide.
\nThis is an idempotent operation.
" + "smithy.api#documentation": "Changes which network ACL a subnet is associated with. By default when you create a\n\t\t\tsubnet, it's automatically associated with the default network ACL. For more\n\t\t\tinformation, see Network\n\t\t\tACLs in the Amazon Virtual Private Cloud User Guide.
\nThis is an idempotent operation.
" } }, "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest": { @@ -75858,7 +75865,7 @@ "aws.protocols#ec2QueryName": "Egress", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether to replace the egress rule.
\n\t\tDefault: If no value is specified, we replace the ingress rule.
", + "smithy.api#documentation": "Indicates whether to replace the egress rule.
\nDefault: If no value is specified, we replace the ingress rule.
", "smithy.api#required": {}, "smithy.api#xmlName": "egress" } @@ -76439,7 +76446,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Submits feedback about the status of an instance. The instance must be in the\n running state. If your experience with the instance differs from the\n instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon\n EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
" + "smithy.api#documentation": "Submits feedback about the status of an instance. The instance must be in the\n running state. If your experience with the instance differs from the\n instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon\n EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
" } }, "com.amazonaws.ec2#ReportInstanceStatusRequest": { @@ -76486,7 +76493,7 @@ "traits": { "aws.protocols#ec2QueryName": "ReasonCode", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The reason codes that describe the health state of your instance.
\n\n instance-stuck-in-state: My instance is stuck in a state.
\n unresponsive: My instance is unresponsive.
\n not-accepting-credentials: My instance is not accepting my\n credentials.
\n password-not-available: A password is not available for my\n instance.
\n performance-network: My instance is experiencing performance\n problems that I believe are network related.
\n performance-instance-store: My instance is experiencing performance\n problems that I believe are related to the instance stores.
\n performance-ebs-volume: My instance is experiencing performance\n problems that I believe are related to an EBS volume.
\n performance-other: My instance is experiencing performance\n problems.
\n other: [explain using the description parameter]
The reason codes that describe the health state of your instance.
\n\n instance-stuck-in-state: My instance is stuck in a state.
\n unresponsive: My instance is unresponsive.
\n not-accepting-credentials: My instance is not accepting my\n credentials.
\n password-not-available: A password is not available for my\n instance.
\n performance-network: My instance is experiencing performance\n problems that I believe are network related.
\n performance-instance-store: My instance is experiencing performance\n problems that I believe are related to the instance stores.
\n performance-ebs-volume: My instance is experiencing performance\n problems that I believe are related to an EBS volume.
\n performance-other: My instance is experiencing performance\n problems.
\n other: [explain using the description parameter]
The ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.
\nThe instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you specify InstanceType, you can't specify\n InstanceRequirements.
The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you specify InstanceType, you can't specify\n InstanceRequirements.
The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.
\nIf you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.
\nThe name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.
\nIf you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.
\nThe ID of the RAM disk.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the RAM disk.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.
\nIndicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).
\nDefault: stop\n
Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).
\nDefault: stop\n
The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Linux instance at\n launch (Linux) or Work with instance\n user data (Windows) in the Amazon Elastic Compute Cloud User Guide.
\n\nIf you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
" + "smithy.api#documentation": "The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Linux instance at\n launch (Linux) or Work with instance\n user data (Windows) in the Amazon Elastic Compute Cloud User Guide.
\nIf you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
" } }, "TagSpecifications": { "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList", "traits": { - "smithy.api#documentation": "The tags to apply to the resources that are created during instance launch.
\nYou can specify tags for the following resources only:
\nInstances
\nVolumes
\nElastic graphics
\nSpot Instance requests
\nNetwork interfaces
\nTo tag a resource after it has been created, see CreateTags.
\nTo tag the launch template itself, you must use the TagSpecification parameter.
\nThe tags to apply to the resources that are created during instance launch.
\nYou can specify tags for the following resources only:
\nInstances
\nVolumes
\nElastic graphics
\nSpot Instance requests
\nNetwork interfaces
\nTo tag a resource after it has been created, see CreateTags.
\nTo tag the launch template itself, you must use the TagSpecification parameter.
\nIndicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.
\nYou can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
" + "smithy.api#documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.
\nYou can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
" } }, "InstanceRequirements": { @@ -76792,7 +76799,7 @@ } }, "traits": { - "smithy.api#documentation": "The information to include in the launch template.
\nYou must specify at least one parameter for the launch template data.
\nThe information to include in the launch template.
\nYou must specify at least one parameter for the launch template data.
\nCreates a Spot Fleet request.
\nThe Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.
\nYou can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.
\nBy default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.
\nAlternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.
\nYou can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.
For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide.
\n \nWe strongly discourage using the RequestSpotFleet API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide.
\nCreates a Spot Fleet request.
\nThe Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.
\nYou can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.
\nBy default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.
\nAlternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.
\nYou can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.
For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide.
\nWe strongly discourage using the RequestSpotFleet API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide.
\nCreates a Spot Instance request.
\nFor more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.
\n \nWe strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances.
\nCreates a Spot Instance request.
\nFor more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.
\nWe strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances.
\nThe user-specified name for a logical grouping of requests.
\nWhen you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.
\nIf there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.
\nDefault: Instances are launched in any available Availability Zone.
", + "smithy.api#documentation": "The user-specified name for a logical grouping of requests.
\nWhen you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.
\nIf there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.
\nDefault: Instances are launched in any available Availability Zone.
", "smithy.api#xmlName": "availabilityZoneGroup" } }, @@ -76909,7 +76916,7 @@ "aws.protocols#ec2QueryName": "InstanceCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of Spot Instances to launch.
\nDefault: 1
", + "smithy.api#documentation": "The maximum number of Spot Instances to launch.
\nDefault: 1
", "smithy.api#xmlName": "instanceCount" } }, @@ -76917,7 +76924,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "LaunchGroup", - "smithy.api#documentation": "The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.
\nDefault: Instances are launched and terminated individually
", + "smithy.api#documentation": "The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.
\nDefault: Instances are launched and terminated individually
", "smithy.api#xmlName": "launchGroup" } }, @@ -76931,7 +76938,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe Spot Instance request type.
\nDefault: one-time\n
The Spot Instance request type.
\nDefault: one-time\n
The start date of the request. If this is a one-time request, the request becomes\n active at this date and time and remains active until all instances launch, the request\n expires, or the request is canceled. If the request is persistent, the request becomes\n active at this date and time and remains active until it expires or is canceled.
\nThe specified start date and time cannot be equal to the current date and time. You\n must specify a start date and time that occurs after the current date and time.
", + "smithy.api#documentation": "The start date of the request. If this is a one-time request, the request becomes\n active at this date and time and remains active until all instances launch, the request\n expires, or the request is canceled. If the request is persistent, the request becomes\n active at this date and time and remains active until it expires or is canceled.
\nThe specified start date and time cannot be equal to the current date and time. You\n must specify a start date and time that occurs after the current date and time.
", "smithy.api#xmlName": "validFrom" } }, @@ -76955,7 +76962,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).
\nFor a persistent request, the request remains active until the\n ValidUntil date and time is reached. Otherwise, the request\n remains active until you cancel it.
For a one-time request, the request remains active until all instances launch,\n the request is canceled, or the ValidUntil date and time is\n reached. By default, the request is valid for 7 days from the date the request\n was created.
The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).
\nFor a persistent request, the request remains active until the\n ValidUntil date and time is reached. Otherwise, the request\n remains active until you cancel it.
For a one-time request, the request remains active until all instances launch,\n the request is canceled, or the ValidUntil date and time is\n reached. By default, the request is valid for 7 days from the date the request\n was created.
Resets an attribute of an instance to its default value. To reset the\n kernel or ramdisk, the instance must be in a stopped\n state. To reset the sourceDestCheck, the instance can be either running or\n stopped.
The sourceDestCheck attribute controls whether source/destination\n checking is enabled. The default value is true, which means checking is\n enabled. This value must be false for a NAT instance to perform NAT. For\n more information, see NAT Instances in the\n Amazon VPC User Guide.
Resets an attribute of an instance to its default value. To reset the\n kernel or ramdisk, the instance must be in a stopped\n state. To reset the sourceDestCheck, the instance can be either running or\n stopped.
The sourceDestCheck attribute controls whether source/destination\n checking is enabled. The default value is true, which means checking is\n enabled. This value must be false for a NAT instance to perform NAT. For\n more information, see NAT Instances in the\n Amazon VPC User Guide.
The attribute to reset.
\nYou can only reset the following attributes: kernel |\n ramdisk | sourceDestCheck.
The attribute to reset.
\nYou can only reset the following attributes: kernel |\n ramdisk | sourceDestCheck.
Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore \n period or restore type for a snapshot that was previously temporarily restored.
\n \nFor more information see \n Restore an archived snapshot and \n modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore \n period or restore type for a snapshot that was previously temporarily restored.
\nFor more information see \n Restore an archived snapshot and \n modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#RestoreSnapshotTierRequest": { @@ -79783,7 +79796,7 @@ "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressResult" }, "traits": { - "smithy.api#documentation": "[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC.\n This action does not apply to security groups for use in EC2-Classic.
\n\nYou can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.
\n[Default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.
\nAmazon Web Services recommends that you describe the security group to verify that the rules were removed.
\n\nRule changes are propagated to instances within the security group as quickly as possible. However, \n a small delay might occur.
" + "smithy.api#documentation": "[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC.\n This action does not apply to security groups for use in EC2-Classic.
\nYou can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.
\n[Default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.
\nAmazon Web Services recommends that you describe the security group to verify that the rules were removed.
\nRule changes are propagated to instances within the security group as quickly as possible. However, \n a small delay might occur.
" } }, "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest": { @@ -79910,7 +79923,7 @@ "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressResult" }, "traits": { - "smithy.api#documentation": "Removes the specified inbound (ingress) rules from a security group.
\n\nYou can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.
\n[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.
\nAmazon Web Services recommends that you describe the security group to verify that the rules were removed.
\n\nRule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
\n \nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nRemoves the specified inbound (ingress) rules from a security group.
\nYou can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.
\n[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.
\nAmazon Web Services recommends that you describe the security group to verify that the rules were removed.
\nRule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nLaunches the specified number of instances using an AMI for which you have\n permissions.
\nYou can specify a number of options, or leave the default options. The following rules\n apply:
\n[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from\n your default VPC for you. If you don't have a default VPC, you must specify a\n subnet ID in the request.
\n[EC2-Classic] If don't specify an Availability Zone, we choose one for\n you.
\nSome instance types must be launched into a VPC. If you do not have a default\n VPC, or if you do not specify a subnet ID, the request fails. For more\n information, see Instance types available only in a VPC.
\n[EC2-VPC] All instances have a network interface with a primary private IPv4\n address. If you don't specify this address, we choose one from the IPv4 range of\n your subnet.
\nNot all instance types support IPv6 addresses. For more information, see\n Instance\n types.
\nIf you don't specify a security group ID, we use the default security group.\n For more information, see Security\n groups.
\nIf any of the AMIs have a product code attached for which the user has not\n subscribed, the request fails.
\nYou can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.
\nTo ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.
\nAn instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.
Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.
\nFor troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a\n VPC. For more information, see Migrate from EC2-Classic to a\n VPC in the Amazon EC2 User Guide.
\nLaunches the specified number of instances using an AMI for which you have\n permissions.
\nYou can specify a number of options, or leave the default options. The following rules\n apply:
\n[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from\n your default VPC for you. If you don't have a default VPC, you must specify a\n subnet ID in the request.
\n[EC2-Classic] If don't specify an Availability Zone, we choose one for\n you.
\nSome instance types must be launched into a VPC. If you do not have a default\n VPC, or if you do not specify a subnet ID, the request fails. For more\n information, see Instance types available only in a VPC.
\n[EC2-VPC] All instances have a network interface with a primary private IPv4\n address. If you don't specify this address, we choose one from the IPv4 range of\n your subnet.
\nNot all instance types support IPv6 addresses. For more information, see\n Instance\n types.
\nIf you don't specify a security group ID, we use the default security group.\n For more information, see Security\n groups.
\nIf any of the AMIs have a product code attached for which the user has not\n subscribed, the request fails.
\nYou can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.
\nTo ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.
\nAn instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.
Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.
\nFor troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a\n VPC. For more information, see Migrate from EC2-Classic to a\n VPC in the Amazon EC2 User Guide.
\nThe instance type. For more information, see Instance types in the\n Amazon EC2 User Guide.
\nDefault: m1.small\n
The instance type. For more information, see Instance types in the\n Amazon EC2 User Guide.
\nDefault: m1.small\n
[EC2-VPC] The number of IPv6 addresses to associate with the primary network\n interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\n cannot specify this option and the option to assign specific IPv6 addresses in the same\n request. You can specify this option if you've specified a minimum number of instances\n to launch.
\nYou cannot specify this option and the network interfaces option in the same\n request.
" + "smithy.api#documentation": "[EC2-VPC] The number of IPv6 addresses to associate with the primary network\n interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\n cannot specify this option and the option to assign specific IPv6 addresses in the same\n request. You can specify this option if you've specified a minimum number of instances\n to launch.
\nYou cannot specify this option and the network interfaces option in the same\n request.
" } }, "Ipv6Addresses": { "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { - "smithy.api#documentation": "[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the\n primary network interface. You cannot specify this option and the option to assign a\n number of IPv6 addresses in the same request. You cannot specify this option if you've\n specified a minimum number of instances to launch.
\nYou cannot specify this option and the network interfaces option in the same\n request.
", + "smithy.api#documentation": "[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the\n primary network interface. You cannot specify this option and the option to assign a\n number of IPv6 addresses in the same request. You cannot specify this option if you've\n specified a minimum number of instances to launch.
\nYou cannot specify this option and the network interfaces option in the same\n request.
", "smithy.api#xmlName": "Ipv6Address" } }, "KernelId": { "target": "com.amazonaws.ec2#KernelId", "traits": { - "smithy.api#documentation": "The ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.
\nThe ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.
\nThe name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.
\nIf you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.
\nThe name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.
\nIf you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.
\nThe maximum number of instances to launch. If you specify more instances than Amazon\n EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible\n number of instances above MinCount.
Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 FAQ.
", + "smithy.api#documentation": "The maximum number of instances to launch. If you specify more instances than Amazon\n EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible\n number of instances above MinCount.
Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 FAQ.
", "smithy.api#required": {} } }, @@ -80555,7 +80568,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The minimum number of instances to launch. If you specify a minimum that is more\n instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2\n launches no instances.
\nConstraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 General FAQ.
", + "smithy.api#documentation": "The minimum number of instances to launch. If you specify a minimum that is more\n instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2\n launches no instances.
\nConstraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 General FAQ.
", "smithy.api#required": {} } }, @@ -80574,27 +80587,27 @@ "RamdiskId": { "target": "com.amazonaws.ec2#RamdiskId", "traits": { - "smithy.api#documentation": "The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and\n search for the kernel ID.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.
\nThe ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and\n search for the kernel ID.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.
\nThe IDs of the security groups. You can create a security group using CreateSecurityGroup.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface.
", + "smithy.api#documentation": "The IDs of the security groups. You can create a security group using CreateSecurityGroup.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface.
", "smithy.api#xmlName": "SecurityGroupId" } }, "SecurityGroups": { "target": "com.amazonaws.ec2#SecurityGroupStringList", "traits": { - "smithy.api#documentation": "[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you\n must use security group IDs instead.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface.
\nDefault: Amazon EC2 uses the default security group.
", + "smithy.api#documentation": "[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you\n must use security group IDs instead.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface.
\nDefault: Amazon EC2 uses the default security group.
", "smithy.api#xmlName": "SecurityGroup" } }, "SubnetId": { "target": "com.amazonaws.ec2#SubnetId", "traits": { - "smithy.api#documentation": "[EC2-VPC] The ID of the subnet to launch the instance into.
\nIf you specify a network interface, you must specify any subnets as part of the\n network interface.
" + "smithy.api#documentation": "[EC2-VPC] The ID of the subnet to launch the instance into.
\nIf you specify a network interface, you must specify any subnets as part of the\n network interface.
" } }, "UserData": { @@ -80615,7 +80628,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for\n the request to ensure idempotency.
\n\nFor more information, see Ensuring\n Idempotency.
\nConstraints: Maximum 64 ASCII characters
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for\n the request to ensure idempotency.
\nFor more information, see Ensuring\n Idempotency.
\nConstraints: Maximum 64 ASCII characters
", "smithy.api#idempotencyToken": {}, "smithy.api#xmlName": "clientToken" } @@ -80626,7 +80639,7 @@ "aws.protocols#ec2QueryName": "DisableApiTermination", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.
Default: false\n
If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.
Default: false\n
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.
\nDefault: false\n
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.
\nDefault: false\n
Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).
\nDefault: stop\n
Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).
\nDefault: stop\n
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.
\nOnly one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.
\nYou cannot specify this option and the network interfaces option in the same\n request.
", + "smithy.api#documentation": "[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.
\nOnly one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.
\nYou cannot specify this option and the network interfaces option in the same\n request.
", "smithy.api#xmlName": "privateIpAddress" } }, @@ -80691,14 +80704,14 @@ "ElasticInferenceAccelerators": { "target": "com.amazonaws.ec2#ElasticInferenceAccelerators", "traits": { - "smithy.api#documentation": "An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.
\nYou cannot specify accelerators from different generations in the same request.
", + "smithy.api#documentation": "An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.
\nYou cannot specify accelerators from different generations in the same request.
", "smithy.api#xmlName": "ElasticInferenceAccelerator" } }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "The tags to apply to the resources that are created during instance launch.
\nYou can specify tags for the following resources only:
\nInstances
\nVolumes
\nElastic graphics
\nSpot Instance requests
\nNetwork interfaces
\nTo tag a resource after it has been created, see CreateTags.
", + "smithy.api#documentation": "The tags to apply to the resources that are created during instance launch.
\nYou can specify tags for the following resources only:
\nInstances
\nVolumes
\nElastic graphics
\nSpot Instance requests
\nNetwork interfaces
\nTo tag a resource after it has been created, see CreateTags.
", "smithy.api#xmlName": "TagSpecification" } }, @@ -80711,13 +80724,13 @@ "InstanceMarketOptions": { "target": "com.amazonaws.ec2#InstanceMarketOptionsRequest", "traits": { - "smithy.api#documentation": "The market (purchasing) option for the instances.
\nFor RunInstances, persistent Spot Instance requests are\n only supported when InstanceInterruptionBehavior is set\n to either hibernate or stop.
The market (purchasing) option for the instances.
\nFor RunInstances, persistent Spot Instance requests are\n only supported when InstanceInterruptionBehavior is set\n to either hibernate or stop.
The credit option for CPU usage of the burstable performance instance. Valid values\n are standard and unlimited. To change this attribute after\n launch, use \n ModifyInstanceCreditSpecification. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a/T4g\n instances)
For T3 instances with host tenancy, only standard is\n supported.
The credit option for CPU usage of the burstable performance instance. Valid values\n are standard and unlimited. To change this attribute after\n launch, use \n ModifyInstanceCreditSpecification. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a/T4g\n instances)
For T3 instances with host tenancy, only standard is\n supported.
Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon EC2 User Guide.
\nYou can't enable hibernation and Amazon Web Services Nitro Enclaves on the same\n instance.
" + "smithy.api#documentation": "Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon EC2 User Guide.
\nYou can't enable hibernation and Amazon Web Services Nitro Enclaves on the same\n instance.
" } }, "LicenseSpecifications": { @@ -80754,7 +80767,7 @@ "EnclaveOptions": { "target": "com.amazonaws.ec2#EnclaveOptionsRequest", "traits": { - "smithy.api#documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.
\nYou can't enable Amazon Web Services Nitro Enclaves and hibernation on the same\n instance.
" + "smithy.api#documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.
\nYou can't enable Amazon Web Services Nitro Enclaves and hibernation on the same\n instance.
" } }, "PrivateDnsNameOptions": { @@ -81381,7 +81394,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum\n \t\tratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for\n \t\tvolumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n \t\tinstances built on the Nitro System. Other instance families guarantee performance up to\n \t\t32,000 IOPS. For more information, see Amazon EBS volume types in the\n \t\tAmazon EC2 User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.
The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum\n \t\tratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for\n \t\tvolumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n \t\tinstances built on the Nitro System. Other instance families guarantee performance up to\n \t\t32,000 IOPS. For more information, see Amazon EBS volume types in the\n \t\tAmazon EC2 User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.
One or more filters. The possible values are:
\n\n group-ip-address - The IP address of the transit gateway multicast group.
\n is-group-member - The resource is a group member. Valid values are true | false.
\n is-group-source - The resource is a group source. Valid values are true | false.
\n member-type - The member type. Valid values are igmp | static.
\n resource-id - The ID of the resource.
\n resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
\n source-type - The source type. Valid values are igmp | static.
\n subnet-id - The ID of the subnet.
\n transit-gateway-attachment-id - The id of the transit gateway attachment.
One or more filters. The possible values are:
\n\n group-ip-address - The IP address of the transit gateway multicast group.
\n is-group-member - The resource is a group member. Valid values are true | false.
\n is-group-source - The resource is a group source. Valid values are true | false.
\n member-type - The member type. Valid values are igmp | static.
\n resource-id - The ID of the resource.
\n resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
\n source-type - The source type. Valid values are igmp | static.
\n subnet-id - The ID of the subnet.
\n transit-gateway-attachment-id - The id of the transit gateway attachment.
The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
Describes the description of a security group rule.
\nYou can use this when you want to update the security group rule description for either an inbound or outbound rule.
" + "smithy.api#documentation": "Describes the description of a security group rule.
\nYou can use this when you want to update the security group rule description for either an inbound or outbound rule.
" } }, "com.amazonaws.ec2#SecurityGroupRuleDescriptionList": { @@ -82295,7 +82308,7 @@ "IpProtocol": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
Describes a security group rule.
\nYou must specify exactly one of the following parameters, based on the rule type:
\nCidrIpv4
\nCidrIpv6
\nPrefixListId
\nReferencedGroupId
\nWhen you modify a rule, you cannot change the rule type. For example, if the rule \n uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 \n address range.
Describes a security group rule.
\nYou must specify exactly one of the following parameters, based on the rule type:
\nCidrIpv4
\nCidrIpv6
\nPrefixListId
\nReferencedGroupId
\nWhen you modify a rule, you cannot change the rule type. For example, if the rule \n uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 \n address range.
Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).
\n\nIn general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.
\n\nBefore sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.
\n\nFor more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) (Linux instances) or Send a diagnostic\n interrupt (for advanced users) (Windows instances).
" + "smithy.api#documentation": "Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).
\nIn general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.
\nBefore sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.
\nFor more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) (Linux instances) or Send a diagnostic\n interrupt (for advanced users) (Windows instances).
" } }, "com.amazonaws.ec2#SendDiagnosticInterruptRequest": { @@ -82718,7 +82731,7 @@ "target": "com.amazonaws.ec2#DnsNameState", "traits": { "aws.protocols#ec2QueryName": "PrivateDnsNameVerificationState", - "smithy.api#documentation": "The verification state of the VPC endpoint service.
\nConsumers of the endpoint service cannot use the private name when the state is not verified.
The verification state of the VPC endpoint service.
\nConsumers of the endpoint service cannot use the private name when the state is not verified.
The replacement strategy to use. Only available for fleets of type\n maintain.
\n launch - Spot Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet\n does not terminate the instances that receive a rebalance notification. You can\n terminate the old instances, or you can leave them running. You are charged for all\n instances while they are running.
\n launch-before-terminate - Spot Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.
The replacement strategy to use. Only available for fleets of type\n maintain.
\n launch - Spot Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet\n does not terminate the instances that receive a rebalance notification. You can\n terminate the old instances, or you can leave them running. You are charged for all\n instances while they are running.
\n launch-before-terminate - Spot Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nRequired when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nRequired when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
\nIf the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
", + "smithy.api#documentation": "The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
\nIf the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
", "smithy.api#xmlName": "weightedCapacity" } }, @@ -83966,7 +83979,7 @@ "target": "com.amazonaws.ec2#AllocationStrategy", "traits": { "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide.
\n \nSpot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
\nSpot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
Spot Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nSpot Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowestPrice\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide.
\nSpot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
\nSpot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
Spot Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nSpot Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowestPrice\n
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nOne or more Classic Load Balancers and target groups to attach to the Spot Fleet\n request. Spot Fleet registers the running Spot Instances with the specified Classic Load\n Balancers and target groups.
\nWith Network Load Balancers, Spot Fleet cannot register instances that have the\n following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2,\n M3, and T1.
", + "smithy.api#documentation": "One or more Classic Load Balancers and target groups to attach to the Spot Fleet\n request. Spot Fleet registers the running Spot Instances with the specified Classic Load\n Balancers and target groups.
\nWith Network Load Balancers, Spot Fleet cannot register instances that have the\n following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2,\n M3, and T1.
", "smithy.api#xmlName": "loadBalancersConfig" } }, @@ -84159,7 +84172,7 @@ "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of\n pools that you specified.
", + "smithy.api#documentation": "The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of\n pools that you specified.
", "smithy.api#xmlName": "instancePoolsToUseCount" } }, @@ -84365,7 +84378,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).
\nFor a persistent request, the request remains active until the validUntil date\n and time is reached. Otherwise, the request remains active until you cancel it.\n
For a one-time request, the request remains active until all instances launch,\n the request is canceled, or the validUntil date and time is reached. By default, the\n request is valid for 7 days from the date the request was created.
The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).
\nFor a persistent request, the request remains active until the validUntil date\n and time is reached. Otherwise, the request remains active until you cancel it.\n
For a one-time request, the request remains active until all instances launch,\n the request is canceled, or the validUntil date and time is reached. By default, the\n request is valid for 7 days from the date the request was created.
The maximum hourly price that you're willing to pay for a Spot Instance. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.
\nThe maximum hourly price that you're willing to pay for a Spot Instance. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.
\nThe end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n Supported only for persistent requests.
\nFor a persistent request, the request remains active until the\n ValidUntil date and time is reached. Otherwise, the request\n remains active until you cancel it.
For a one-time request, ValidUntil is not supported. The request\n remains active until all instances launch or you cancel the request.
The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n Supported only for persistent requests.
\nFor a persistent request, the request remains active until the\n ValidUntil date and time is reached. Otherwise, the request\n remains active until you cancel it.
For a one-time request, ValidUntil is not supported. The request\n remains active until all instances launch or you cancel the request.
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\n \nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nEC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowest-price\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nEC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowest-price\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\n \nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nEC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowest-price\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nEC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowest-price\n
The Availability Zone.
\n[Spot Fleet only] To specify multiple Availability Zones, separate them using commas;\n for example, \"us-west-2a, us-west-2b\".
", + "smithy.api#documentation": "The Availability Zone.
\n[Spot Fleet only] To specify multiple Availability Zones, separate them using commas;\n for example, \"us-west-2a, us-west-2b\".
", "smithy.api#xmlName": "availabilityZone" } }, @@ -84885,7 +84898,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
\nStarts an Amazon EBS-backed instance that you've previously stopped.
\nInstances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nBefore stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.
\nPerforming this operation on an instance that uses an instance store as its root\n device returns an error.
\n\nIf you attempt to start a T3 instance with host tenancy and the\n unlimted CPU credit option, the request fails. The\n unlimited CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard, or\n change its tenancy to default or dedicated.
For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Starts an Amazon EBS-backed instance that you've previously stopped.
\nInstances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nBefore stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.
\nPerforming this operation on an instance that uses an instance store as its root\n device returns an error.
\nIf you attempt to start a T3 instance with host tenancy and the\n unlimted CPU credit option, the request fails. The\n unlimited CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard, or\n change its tenancy to default or dedicated.
For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#StartInstancesRequest": { @@ -85266,7 +85279,7 @@ "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult" }, "traits": { - "smithy.api#documentation": "Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.
\nThe service provider must successfully perform the verification before the consumer can use the name to access the service.
\nBefore the service provider runs this command, they must add a record to the DNS server.
" + "smithy.api#documentation": "Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.
\nThe service provider must successfully perform the verification before the consumer can use the name to access the service.
\nBefore the service provider runs this command, they must add a record to the DNS server.
" } }, "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest": { @@ -85373,7 +85386,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "The message for the state change.
\n\n Server.InsufficientInstanceCapacity: There was insufficient\n capacity available to satisfy the launch request.
\n Server.InternalError: An internal error caused the instance to\n terminate during launch.
\n Server.ScheduledStop: The instance was stopped due to a scheduled\n retirement.
\n Server.SpotInstanceShutdown: The instance was stopped because the\n number of Spot requests with a maximum price equal to or higher than the Spot\n price exceeded available capacity or because of an increase in the Spot\n price.
\n Server.SpotInstanceTermination: The instance was terminated\n because the number of Spot requests with a maximum price equal to or higher than\n the Spot price exceeded available capacity or because of an increase in the Spot\n price.
\n Client.InstanceInitiatedShutdown: The instance was shut down\n using the shutdown -h command from the instance.
\n Client.InstanceTerminated: The instance was terminated or\n rebooted during AMI creation.
\n Client.InternalError: A client error caused the instance to\n terminate during launch.
\n Client.InvalidSnapshot.NotFound: The specified snapshot was not\n found.
\n Client.UserInitiatedHibernate: Hibernation was initiated on the\n instance.
\n Client.UserInitiatedShutdown: The instance was shut down using\n the Amazon EC2 API.
\n Client.VolumeLimitExceeded: The limit on the number of EBS\n volumes or total storage was exceeded. Decrease usage or request an increase in\n your account limits.
The message for the state change.
\n\n Server.InsufficientInstanceCapacity: There was insufficient\n capacity available to satisfy the launch request.
\n Server.InternalError: An internal error caused the instance to\n terminate during launch.
\n Server.ScheduledStop: The instance was stopped due to a scheduled\n retirement.
\n Server.SpotInstanceShutdown: The instance was stopped because the\n number of Spot requests with a maximum price equal to or higher than the Spot\n price exceeded available capacity or because of an increase in the Spot\n price.
\n Server.SpotInstanceTermination: The instance was terminated\n because the number of Spot requests with a maximum price equal to or higher than\n the Spot price exceeded available capacity or because of an increase in the Spot\n price.
\n Client.InstanceInitiatedShutdown: The instance was shut down\n using the shutdown -h command from the instance.
\n Client.InstanceTerminated: The instance was terminated or\n rebooted during AMI creation.
\n Client.InternalError: A client error caused the instance to\n terminate during launch.
\n Client.InvalidSnapshot.NotFound: The specified snapshot was not\n found.
\n Client.UserInitiatedHibernate: Hibernation was initiated on the\n instance.
\n Client.UserInitiatedShutdown: The instance was shut down using\n the Amazon EC2 API.
\n Client.VolumeLimitExceeded: The limit on the number of EBS\n volumes or total storage was exceeded. Decrease usage or request an increase in\n your account limits.
Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.
\nYou can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.
\nWe don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nYou can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.
\nWhen you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.
\nStopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
\nWhen you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.
\nYou can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.
\nWe don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nYou can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.
\nWhen you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.
\nStopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
\nWhen you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#StopInstancesRequest": { @@ -85502,7 +85515,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon EC2 User Guide.
\n Default: false\n
Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon EC2 User Guide.
\n Default: false\n
Forces the instances to stop. The instances do not have an opportunity to flush file\n system caches or file system metadata. If you use this option, you must perform file\n system check and repair procedures. This option is not recommended for Windows\n instances.
\nDefault: false\n
Forces the instances to stop. The instances do not have an opportunity to flush file\n system caches or file system metadata. If you use this option, you must perform file\n system check and repair procedures. This option is not recommended for Windows\n instances.
\nDefault: false\n
Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.
\n\nIf you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.
\n\nIf you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:
\nThe specified instances that are in the same Availability Zone as the\n protected instance are not terminated.
\nThe specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.
\nFor example, say you have the following instances:
\nInstance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:
\nInstance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.
Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.
Terminated instances remain visible after termination (for approximately one\n hour).
\nBy default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.
\nYou can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.
\nIf you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.
\nIf you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:
\nThe specified instances that are in the same Availability Zone as the\n protected instance are not terminated.
\nThe specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.
\nFor example, say you have the following instances:
\nInstance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:
\nInstance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.
Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.
Terminated instances remain visible after termination (for approximately one\n hour).
\nBy default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.
\nYou can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#TerminateInstancesRequest": { @@ -86938,7 +86951,7 @@ "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the instances.
\nConstraints: Up to 1000 instance IDs. We recommend breaking up this request into\n smaller batches.
", + "smithy.api#documentation": "The IDs of the instances.
\nConstraints: Up to 1000 instance IDs. We recommend breaking up this request into\n smaller batches.
", "smithy.api#required": {}, "smithy.api#xmlName": "InstanceId" } @@ -90742,7 +90755,7 @@ } }, "traits": { - "smithy.api#documentation": "Currently available in limited preview only. \n If you are interested in using this feature, contact your account manager.
\nInformation about an association between a branch network interface with a trunk network interface.
" + "smithy.api#documentation": "Currently available in limited preview only. \n If you are interested in using this feature, contact your account manager.
\nInformation about an association between a branch network interface with a trunk network interface.
" } }, "com.amazonaws.ec2#TrunkInterfaceAssociationId": { @@ -91584,7 +91597,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "The name of the security group. In a request, use this parameter for a security group\n in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the\n security group ID.
\nFor a referenced security group in another VPC, this value is not returned if the\n referenced security group is deleted.
", + "smithy.api#documentation": "The name of the security group. In a request, use this parameter for a security group\n in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the\n security group ID.
\nFor a referenced security group in another VPC, this value is not returned if the\n referenced security group is deleted.
", "smithy.api#xmlName": "groupName" } }, @@ -91600,7 +91613,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "The ID of an Amazon Web Services account.
\nFor a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.
\n[EC2-Classic] Required when adding or removing rules that reference a security group\n in another Amazon Web Services account.
", + "smithy.api#documentation": "The ID of an Amazon Web Services account.
\nFor a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.
\n[EC2-Classic] Required when adding or removing rules that reference a security group\n in another Amazon Web Services account.
", "smithy.api#xmlName": "userId" } }, @@ -91622,7 +91635,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a security group and Amazon Web Services account ID pair.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes a security group and Amazon Web Services account ID pair.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n\tDescribes whether a VPC is enabled for ClassicLink.
" + "smithy.api#documentation": "We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes whether a VPC is enabled for ClassicLink.
" } }, "com.amazonaws.ec2#VpcClassicLinkIdList": { @@ -95206,7 +95219,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OutsideIpAddressType", - "smithy.api#documentation": "The type of IPv4 address assigned to the outside interface of the customer gateway.
\nValid values: PrivateIpv4 | PublicIpv4\n
Default: PublicIpv4\n
The type of IPv4 address assigned to the outside interface of the customer gateway.
\nValid values: PrivateIpv4 | PublicIpv4\n
Default: PublicIpv4\n
Indicate whether to enable acceleration for the VPN connection.
\nDefault: false\n
Indicate whether to enable acceleration for the VPN connection.
\nDefault: false\n
Indicate whether the VPN connection uses static routes only. If you are creating a VPN\n connection for a device that does not support BGP, you must specify true.\n Use CreateVpnConnectionRoute to create a static route.
Default: false\n
Indicate whether the VPN connection uses static routes only. If you are creating a VPN\n connection for a device that does not support BGP, you must specify true.\n Use CreateVpnConnectionRoute to create a static route.
Default: false\n
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
\nDefault: ipv4\n
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
\nDefault: ipv4\n
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
\nDefault: 0.0.0.0/0\n
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
\nDefault: 0.0.0.0/0\n
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
\nDefault: 0.0.0.0/0\n
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
\nDefault: 0.0.0.0/0\n
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
\nDefault: ::/0\n
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
\nDefault: ::/0\n
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
\nDefault: ::/0\n
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
\nDefault: ::/0\n
The type of IPv4 address assigned to the outside interface of the customer gateway device.
\nValid values: PrivateIpv4 | PublicIpv4\n
Default: PublicIpv4\n
The type of IPv4 address assigned to the outside interface of the customer gateway device.
\nValid values: PrivateIpv4 | PublicIpv4\n
Default: PublicIpv4\n
The transit gateway attachment ID to use for the VPN tunnel.
\nRequired if OutsideIpAddressType is set to PrivateIpv4.
The transit gateway attachment ID to use for the VPN tunnel.
\nRequired if OutsideIpAddressType is set to PrivateIpv4.
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.
\nConstraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:
\n 169.254.0.0/30\n
\n 169.254.1.0/30\n
\n 169.254.2.0/30\n
\n 169.254.3.0/30\n
\n 169.254.4.0/30\n
\n 169.254.5.0/30\n
\n 169.254.169.252/30\n
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.
\nConstraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:
\n 169.254.0.0/30\n
\n 169.254.1.0/30\n
\n 169.254.2.0/30\n
\n 169.254.3.0/30\n
\n 169.254.4.0/30\n
\n 169.254.5.0/30\n
\n 169.254.169.252/30\n
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.
\nConstraints: A size /126 CIDR block from the local fd00::/8 range.
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.
\nConstraints: A size /126 CIDR block from the local fd00::/8 range.
The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and customer gateway.
\nConstraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).
" + "smithy.api#documentation": "The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and customer gateway.
\nConstraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).
" } }, "Phase1LifetimeSeconds": { @@ -95565,7 +95578,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The lifetime for phase 1 of the IKE negotiation, in seconds.
\nConstraints: A value between 900 and 28,800.
\nDefault: 28800\n
The lifetime for phase 1 of the IKE negotiation, in seconds.
\nConstraints: A value between 900 and 28,800.
\nDefault: 28800\n
The lifetime for phase 2 of the IKE negotiation, in seconds.
\nConstraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.
Default: 3600\n
The lifetime for phase 2 of the IKE negotiation, in seconds.
\nConstraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.
Default: 3600\n
The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540\n
The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540\n
The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
\nDefault: 100\n
The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
\nDefault: 100\n
The number of packets in an IKE replay window.
\nConstraints: A value between 64 and 2048.
\nDefault: 1024\n
The number of packets in an IKE replay window.
\nConstraints: A value between 64 and 2048.
\nDefault: 1024\n
The number of seconds after which a DPD timeout occurs.
\nConstraints: A value greater than or equal to 30.
\nDefault: 30\n
The number of seconds after which a DPD timeout occurs.
\nConstraints: A value greater than or equal to 30.
\nDefault: 30\n
The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart\n
Default: clear\n
The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart\n
Default: clear\n
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.
\nValid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.
\nValid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.
\nValid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.
\nValid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.
\nValid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.
\nValid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.
\nValid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.
\nValid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.
\nValid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.
\nValid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.
\nValid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.
\nValid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n
The IKE versions that are permitted for the VPN tunnel.
\nValid values: ikev1 | ikev2\n
The IKE versions that are permitted for the VPN tunnel.
\nValid values: ikev1 | ikev2\n
The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.
Valid Values: add | start\n
Default: add\n
The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.
Valid Values: add | start\n
Default: add\n
Creates a signaling channel.
\n\n CreateSignalingChannel is an asynchronous operation.
Creates a signaling channel.
\n\n CreateSignalingChannel is an asynchronous operation.
Creates a new Kinesis video stream.
\n\nWhen you create a new stream, Kinesis Video Streams assigns it a version number.\n When you change the stream's metadata, Kinesis Video Streams updates the version.
\n\n CreateStream is an asynchronous operation.
For information about how the service works, see How it Works.
\nYou must have permissions for the KinesisVideo:CreateStream\n action.
Creates a new Kinesis video stream.
\nWhen you create a new stream, Kinesis Video Streams assigns it a version number.\n When you change the stream's metadata, Kinesis Video Streams updates the version.
\n\n CreateStream is an asynchronous operation.
For information about how the service works, see How it Works.
\nYou must have permissions for the KinesisVideo:CreateStream\n action.
The name of the device that is writing to the stream.
\nIn the current implementation, Kinesis Video Streams does not use this\n name.
\nThe name of the device that is writing to the stream.
\nIn the current implementation, Kinesis Video Streams does not use this\n name.
\nA name for the stream that you are creating.
\nThe stream name is an identifier for the stream, and must be unique for each\n account and region.
", + "smithy.api#documentation": "A name for the stream that you are creating.
\nThe stream name is an identifier for the stream, and must be unique for each\n account and region.
", "smithy.api#required": {} } }, "MediaType": { "target": "com.amazonaws.kinesisvideo#MediaType", "traits": { - "smithy.api#documentation": "The media type of the stream. Consumers of the stream can use this information when\n processing the stream. For more information about media types, see Media\n Types. If you choose to specify the MediaType, see Naming Requirements\n for guidelines.
Example valid values include \"video/h264\" and \"video/h264,audio/aac\".
\nThis parameter is optional; the default value is null (or empty in\n JSON).
The media type of the stream. Consumers of the stream can use this information when\n processing the stream. For more information about media types, see Media\n Types. If you choose to specify the MediaType, see Naming Requirements\n for guidelines.
Example valid values include \"video/h264\" and \"video/h264,audio/aac\".
\nThis parameter is optional; the default value is null (or empty in\n JSON).
The ID of the Key Management Service (KMS) key that you want Kinesis Video\n Streams to use to encrypt stream data.
\nIf no key ID is specified, the default, Kinesis Video-managed key\n (aws/kinesisvideo) is used.
For more information, see DescribeKey.
" + "smithy.api#documentation": "The ID of the Key Management Service (KMS) key that you want Kinesis Video\n Streams to use to encrypt stream data.
\nIf no key ID is specified, the default, Kinesis Video-managed key\n (aws/kinesisvideo) is used.
For more information, see DescribeKey.
" } }, "DataRetentionInHours": { "target": "com.amazonaws.kinesisvideo#DataRetentionInHours", "traits": { - "smithy.api#documentation": "The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
\nThe default value is 0, indicating that the stream does not persist data.
\nWhen the DataRetentionInHours value is 0, consumers can still consume\n the fragments that remain in the service host buffer, which has a retention time limit\n of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the\n buffer when either limit is reached.
The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
\nThe default value is 0, indicating that the stream does not persist data.
\nWhen the DataRetentionInHours value is 0, consumers can still consume\n the fragments that remain in the service host buffer, which has a retention time limit\n of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the\n buffer when either limit is reached.
Deletes a Kinesis video stream and the data contained in the stream.
\nThis method marks the stream for deletion, and makes the data in the stream\n inaccessible immediately.
\n\n
To ensure that you have the latest version of the stream before deleting it, you\n can specify the stream version. Kinesis Video Streams assigns a version to each stream.\n When you update a stream, Kinesis Video Streams assigns a new version number. To get the\n latest stream version, use the DescribeStream API.
This operation requires permission for the KinesisVideo:DeleteStream\n action.
Deletes a Kinesis video stream and the data contained in the stream.
\nThis method marks the stream for deletion, and makes the data in the stream\n inaccessible immediately.
\n\n
To ensure that you have the latest version of the stream before deleting it, you\n can specify the stream version. Kinesis Video Streams assigns a version to each stream.\n When you update a stream, Kinesis Video Streams assigns a new version number. To get the\n latest stream version, use the DescribeStream API.
This operation requires permission for the KinesisVideo:DeleteStream\n action.
Optional: The version of the stream that you want to delete.
\nSpecify the version as a safeguard to ensure that your are deleting the correct\n stream. To get the stream version, use the DescribeStream API.
If not specified, only the CreationTime is checked before deleting the\n stream.
Optional: The version of the stream that you want to delete.
\nSpecify the version as a safeguard to ensure that your are deleting the correct\n stream. To get the stream version, use the DescribeStream API.
If not specified, only the CreationTime is checked before deleting the\n stream.
The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention\n time is 720 hours, which translates to 30 days.
" + } + }, + "LocalSizeConfig": { + "target": "com.amazonaws.kinesisvideo#LocalSizeConfig", + "traits": { + "smithy.api#documentation": "The value of the local size required in order to delete the edge configuration.
" + } + }, + "DeleteAfterUpload": { + "target": "com.amazonaws.kinesisvideo#DeleteAfterUpload", + "traits": { + "smithy.api#documentation": "The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to \n the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are \n set to true, such as when the limit for the EdgeRetentionInHours, or the\n MaxLocalMediaSizeInMB, has been reached. \n
Since the default value is set to true, configure the uploader schedule such \n that the media files are not being deleted before they are initially uploaded to AWS cloud.
The configuration details required to delete the connection of the stream from the Edge Agent.
" + } + }, + "com.amazonaws.kinesisvideo#DescribeEdgeConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#DescribeEdgeConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#DescribeEdgeConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kinesisvideo#StreamEdgeConfigurationNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. \n Use this API to get the status of the configuration if the configuration is in sync with the \n Edge Agent.
The name of the stream whose edge configuration you want to update. Specify either the StreamName or \n the StreamARN.\n
The Amazon Resource Name (ARN) of the stream. Specify either the StreamNameor the StreamARN.
The name of the stream from which the edge configuration was updated.
" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stream.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which a stream’s edge configuration was first created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which a stream’s edge configuration was last updated.
" + } + }, + "SyncStatus": { + "target": "com.amazonaws.kinesisvideo#SyncStatus", + "traits": { + "smithy.api#documentation": "The latest status of the edge configuration update.
" + } + }, + "FailedStatusDetails": { + "target": "com.amazonaws.kinesisvideo#FailedStatusDetails", + "traits": { + "smithy.api#documentation": "A description of the generated failure status.
" + } + }, + "EdgeConfig": { + "target": "com.amazonaws.kinesisvideo#EdgeConfig", + "traits": { + "smithy.api#documentation": "A description of the stream's edge configuration that will be used to sync \n with the Edge Agent IoT Greengrass component. The Edge Agent component will run\n on an IoT Hub Device setup at your premise.
" + } + } + } + }, "com.amazonaws.kinesisvideo#DescribeImageGenerationConfiguration": { "type": "operation", "input": { @@ -866,22 +1013,79 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.kinesisvideo#DurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.kinesisvideo#EdgeConfig": { + "type": "structure", + "members": { + "HubDeviceArn": { + "target": "com.amazonaws.kinesisvideo#HubDeviceArn", + "traits": { + "smithy.api#documentation": "The \"Internet of Things (IoT) Thing\" Arn of the stream.
", + "smithy.api#required": {} + } + }, + "RecorderConfig": { + "target": "com.amazonaws.kinesisvideo#RecorderConfig", + "traits": { + "smithy.api#documentation": "The recorder configuration consists of the local MediaSourceConfig details, that are used as \n credentials to access the local media files streamed on the camera.
The uploader configuration contains the ScheduleExpression details that are used, to\n schedule upload jobs for the recorded media files from the Edge Agent, to a Kinesis Video Stream.
The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration\n (LocalSizeConfig) details that are used to make the deletion.
A description of the stream's edge configuration that will be used to sync \n with the Edge Agent IoT Greengrass component. The Edge Agent component will run\n on an IoT Hub Device setup at your premise.
" + } + }, + "com.amazonaws.kinesisvideo#EdgeRetentionInHours": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 720 + } + } + }, "com.amazonaws.kinesisvideo#ErrorMessage": { "type": "string" }, + "com.amazonaws.kinesisvideo#FailedStatusDetails": { + "type": "string" + }, "com.amazonaws.kinesisvideo#Format": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JPEG", - "name": "JPEG" - }, - { - "value": "PNG", - "name": "PNG" + "type": "enum", + "members": { + "JPEG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JPEG" } - ] + }, + "PNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PNG" + } + } } }, "com.amazonaws.kinesisvideo#FormatConfig": { @@ -900,14 +1104,14 @@ } }, "com.amazonaws.kinesisvideo#FormatConfigKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JPEGQuality", - "name": "JPEGQuality" + "type": "enum", + "members": { + "JPEGQuality": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JPEGQuality" } - ] + } } }, "com.amazonaws.kinesisvideo#FormatConfigValue": { @@ -943,7 +1147,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets an endpoint for a specified stream for either reading or writing. Use this\n endpoint in your application to read from the specified stream (using the\n GetMedia or GetMediaForFragmentList operations) or write\n to it (using the PutMedia operation).\n
The returned endpoint does not have the API name appended. The client needs to\n add the API name to the returned endpoint.
\nIn the request, specify the stream either by StreamName or\n StreamARN.
Gets an endpoint for a specified stream for either reading or writing. Use this\n endpoint in your application to read from the specified stream (using the\n GetMedia or GetMediaForFragmentList operations) or write\n to it (using the PutMedia operation).\n
The returned endpoint does not have the API name appended. The client needs to\n add the API name to the returned endpoint.
\nIn the request, specify the stream either by StreamName or\n StreamARN.
Provides an endpoint for the specified signaling channel to send and receive messages.\n This API uses the SingleMasterChannelEndpointConfiguration input parameter,\n which consists of the Protocols and Role properties.
\n Protocols is used to determine the communication mechanism. For example,\n if you specify WSS as the protocol, this API produces a secure websocket\n endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS\n endpoint.
\n Role determines the messaging permissions. A MASTER role\n results in this API generating an endpoint that a client can use to communicate with any\n of the viewers on the channel. A VIEWER role results in this API generating\n an endpoint that a client can use to communicate only with a MASTER.\n
Provides an endpoint for the specified signaling channel to send and receive messages.\n This API uses the SingleMasterChannelEndpointConfiguration input parameter,\n which consists of the Protocols and Role properties.
\n Protocols is used to determine the communication mechanism. For example,\n if you specify WSS as the protocol, this API produces a secure websocket\n endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS\n endpoint.
\n Role determines the messaging permissions. A MASTER role\n results in this API generating an endpoint that a client can use to communicate with any\n of the viewers on the channel. A VIEWER role results in this API generating\n an endpoint that a client can use to communicate only with a MASTER.\n
The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.
", + "smithy.api#documentation": "The Uniform Resource Identifier (URI) that identifies where the images will be delivered.
", "smithy.api#required": {} } }, @@ -1143,18 +1356,20 @@ } }, "com.amazonaws.kinesisvideo#ImageSelectorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SERVER_TIMESTAMP", - "name": "SERVER_TIMESTAMP" - }, - { - "value": "PRODUCER_TIMESTAMP", - "name": "PRODUCER_TIMESTAMP" + "type": "enum", + "members": { + "SERVER_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_TIMESTAMP" + } + }, + "PRODUCER_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCER_TIMESTAMP" } - ] + } } }, "com.amazonaws.kinesisvideo#InvalidArgumentException": { @@ -1198,24 +1413,6 @@ }, "com.amazonaws.kinesisvideo#KinesisVideo_20170930": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Kinesis Video", - "arnNamespace": "kinesisvideo", - "cloudFormationName": "KinesisVideo", - "cloudTrailEventSource": "kinesisvideo.amazonaws.com", - "endpointPrefix": "kinesisvideo" - }, - "aws.auth#sigv4": { - "name": "kinesisvideo" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "", - "smithy.api#title": "Amazon Kinesis Video Streams", - "smithy.api#xmlNamespace": { - "uri": "https://kinesisvideo.amazonaws.com/doc/2017-09-30/" - } - }, "version": "2017-09-30", "operations": [ { @@ -1230,6 +1427,9 @@ { "target": "com.amazonaws.kinesisvideo#DeleteStream" }, + { + "target": "com.amazonaws.kinesisvideo#DescribeEdgeConfiguration" + }, { "target": "com.amazonaws.kinesisvideo#DescribeImageGenerationConfiguration" }, @@ -1260,6 +1460,9 @@ { "target": "com.amazonaws.kinesisvideo#ListTagsForStream" }, + { + "target": "com.amazonaws.kinesisvideo#StartEdgeConfigurationUpdate" + }, { "target": "com.amazonaws.kinesisvideo#TagResource" }, @@ -1278,16 +1481,1619 @@ { "target": "com.amazonaws.kinesisvideo#UpdateImageGenerationConfiguration" }, - { - "target": "com.amazonaws.kinesisvideo#UpdateNotificationConfiguration" + { + "target": "com.amazonaws.kinesisvideo#UpdateNotificationConfiguration" + }, + { + "target": "com.amazonaws.kinesisvideo#UpdateSignalingChannel" + }, + { + "target": "com.amazonaws.kinesisvideo#UpdateStream" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Kinesis Video", + "arnNamespace": "kinesisvideo", + "cloudFormationName": "KinesisVideo", + "cloudTrailEventSource": "kinesisvideo.amazonaws.com", + "endpointPrefix": "kinesisvideo" + }, + "aws.auth#sigv4": { + "name": "kinesisvideo" }, - { - "target": "com.amazonaws.kinesisvideo#UpdateSignalingChannel" + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "", + "smithy.api#title": "Amazon Kinesis Video Streams", + "smithy.api#xmlNamespace": { + "uri": "https://kinesisvideo.amazonaws.com/doc/2017-09-30/" }, - { - "target": "com.amazonaws.kinesisvideo#UpdateStream" + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo-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, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo-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, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo.{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://kinesisvideo.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-iso-west-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-iso-west-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-iso-west-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-iso-west-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" } - ] + } }, "com.amazonaws.kinesisvideo#KmsKeyId": { "type": "string", @@ -1442,7 +3248,6 @@ "com.amazonaws.kinesisvideo#ListStreamsInputLimit": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10000 @@ -1558,7 +3363,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of tags associated with the specified stream.
\nIn the request, you must specify either the StreamName or the\n StreamARN.
Returns a list of tags associated with the specified stream.
\nIn the request, you must specify either the StreamName or the\n StreamARN.
The overall maximum size of the media that you want to store for a stream on the Edge Agent.
" + } + }, + "StrategyOnFullSize": { + "target": "com.amazonaws.kinesisvideo#StrategyOnFullSize", + "traits": { + "smithy.api#documentation": "The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.
The configuration details that include the maximum size of the media \n (MaxLocalMediaSizeInMB) that you want to\n store for a stream on the Edge Agent, as well as the strategy that should be used (StrategyOnFullSize) when a stream's\n maximum size has been reached.
The AWS Secrets Manager ARN for the username and password of the camera, or a local media file location.
", + "smithy.api#required": {} + } + }, + "MediaUriType": { + "target": "com.amazonaws.kinesisvideo#MediaUriType", + "traits": { + "smithy.api#documentation": "The Uniform Resource Identifier (Uri) type. The FILE_URI value can be used to stream \n local media files.
The configuration details that consist of the credentials required \n (MediaUriSecretArn and MediaUriType) to access the media files that are \n streamed to the camera.
The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.
", + "smithy.api#documentation": "The Uniform Resource Identifier (URI) that identifies where the images will be delivered.
", "smithy.api#required": {} } } @@ -1699,6 +3582,27 @@ "smithy.api#documentation": "The structure that contains the information required to deliver a notification to a customer.
" } }, + "com.amazonaws.kinesisvideo#RecorderConfig": { + "type": "structure", + "members": { + "MediaSourceConfig": { + "target": "com.amazonaws.kinesisvideo#MediaSourceConfig", + "traits": { + "smithy.api#documentation": "The configuration details that consist of the credentials required \n (MediaUriSecretArn and MediaUriType) to access the media files \n streamed to the camera.\n
The configuration that consists of the ScheduleExpression and the \n DurationInMinutes details that specify the scheduling to record from a camera, or\n local media file, onto the Edge Agent. If the ScheduleExpression attribute is not provided,\n then the Edge Agent will always be set to recording mode.
The recorder configuration consists of the local MediaSourceConfig details that are used as \n credentials to accesss the local media files streamed on the camera.
The resource is currently not available for this operation. New resources cannot be\n created with the same name as existing resources. Also, resources cannot be updated or\n deleted unless they are in an ACTIVE state.
If this exception is returned, do not use it to determine whether the requested\n resource already exists. Instead, it is recommended you use the resource-specific\n describe API, for example, DescribeStream for video streams.
The resource is currently not available for this operation. New resources cannot be\n created with the same name as existing resources. Also, resources cannot be updated or\n deleted unless they are in an ACTIVE state.
If this exception is returned, do not use it to determine whether the requested\n resource already exists. Instead, it is recommended you use the resource-specific\n describe API, for example, DescribeStream for video streams.
The Quartz cron expression that takes care of scheduling jobs to record from the\n camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig,\n then the Edge Agent will always be set to recording mode.
For more information about Quartz, refer to the \n \n Cron Trigger Tutorial\n page to understand the valid expressions and its use.
", + "smithy.api#required": {} + } + }, + "DurationInSeconds": { + "target": "com.amazonaws.kinesisvideo#DurationInSeconds", + "traits": { + "smithy.api#documentation": "The total duration to record the media. If the ScheduleExpression attribute is provided, then the\n DurationInSeconds attribute should also be specified.
This API enables you to specify the duration that the camera,\n or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the ScheduleExpression and the \n DurationInMinutes attributes.
If the ScheduleExpression is not provided,\n then the Edge Agent will always be set to recording mode.
A structure that contains the configuration for the SINGLE_MASTER channel\n type.
An asynchronous API that updates a stream’s existing edge configuration. If this API is invoked for the\n first time, a new edge configuration will be created for the stream, and the sync status will be set to \n SYNCING.
The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent \n IoT Greengrass component that runs on an IoT Hub Device setup at your premise. \n The time to sync can vary and depends on the connectivity of the Hub Device. \n The SyncStatus will be updated as the edge configuration is acknowledged, \n and synced with the Edge Agent. You will have to wait for the sync status to reach a terminal state such as:\n IN_SYNC and SYNC_FAILED, before using this API again.
If you invoke this API during the syncing process, \n a ResourceInUseException will be thrown. The connectivity of the stream's edge configuration\n and the Edge Agent will be retried \n for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.\n
The name of the stream whose edge configuration you want to update. Specify either the StreamName\n or the StreamARN.
The Amazon Resource Name (ARN) of the stream. Specify either the \n StreamName or the StreamARN.
The edge configuration details required to invoke the update process.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kinesisvideo#StartEdgeConfigurationUpdateOutput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "The name of the stream from which the edge configuration was updated.
" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stream.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which a stream’s edge configuration was first created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which a stream’s edge configuration was last updated.
" + } + }, + "SyncStatus": { + "target": "com.amazonaws.kinesisvideo#SyncStatus", + "traits": { + "smithy.api#documentation": " The current sync status of the stream's edge configuration. When you invoke this API, the sync\n status will be set to the SYNCING state. Use the DescribeEdgeConfiguration API\n to get the latest status of the edge configuration.
A description of the generated failure status.
" + } + }, + "EdgeConfig": { + "target": "com.amazonaws.kinesisvideo#EdgeConfig", + "traits": { + "smithy.api#documentation": "A description of the stream's edge configuration that will be used to sync \n with the Edge Agent IoT Greengrass component. The Edge Agent component will run\n on an IoT Hub Device setup at your premise.
" + } + } + } + }, + "com.amazonaws.kinesisvideo#Status": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" } - ] + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.kinesisvideo#StrategyOnFullSize": { + "type": "enum", + "members": { + "DELETE_OLDEST_MEDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_OLDEST_MEDIA" + } + }, + "DENY_NEW_MEDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY_NEW_MEDIA" + } + } + } + }, + "com.amazonaws.kinesisvideo#StreamEdgeConfigurationNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.kinesisvideo#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration\n that you specified.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 } }, "com.amazonaws.kinesisvideo#StreamInfo": { @@ -1944,6 +4023,47 @@ "smithy.api#documentation": "Specifies the condition that streams must satisfy to be returned when you list\n streams (see the ListStreams API). A condition has a comparison operation\n and a value. Currently, you can specify only the BEGINS_WITH operator,\n which finds streams whose names start with a given prefix.
Adds one or more tags to a stream. A tag is a key-value pair\n (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify\n a tag that already exists, the tag value is replaced with the value that you specify in\n the request. For more information, see Using Cost Allocation\n Tags in the Billing and Cost Management and Cost Management User Guide.
\nYou must provide either the StreamName or the\n StreamARN.
This operation requires permission for the KinesisVideo:TagStream\n action.
A Kinesis video stream can support up to 50 tags.
", + "smithy.api#documentation": "Adds one or more tags to a stream. A tag is a key-value pair\n (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify\n a tag that already exists, the tag value is replaced with the value that you specify in\n the request. For more information, see Using Cost Allocation\n Tags in the Billing and Cost Management and Cost Management User Guide.
\nYou must provide either the StreamName or the\n StreamARN.
This operation requires permission for the KinesisVideo:TagStream\n action.
A Kinesis video stream can support up to 50 tags.
", "smithy.api#http": { "method": "POST", "uri": "/tagStream", @@ -2240,7 +4360,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes one or more tags from a stream. In the request, specify only a tag key or\n keys; don't specify the value. If you specify a tag key that does not exist, it's\n ignored.
\nIn the request, you must provide the StreamName or\n StreamARN.
Removes one or more tags from a stream. In the request, specify only a tag key or\n keys; don't specify the value. If you specify a tag key that does not exist, it's\n ignored.
\nIn the request, you must provide the StreamName or\n StreamARN.
Increases or decreases the stream's data retention period by the value that you\n specify. To indicate whether you want to increase or decrease the data retention period,\n specify the Operation parameter in the request body. In the request, you\n must specify either the StreamName or the StreamARN.
The retention period that you specify replaces the current value.
\nThis operation requires permission for the\n KinesisVideo:UpdateDataRetention action.
Changing the data retention period affects the data in the stream as\n follows:
\nIf the data retention period is increased, existing data is retained for\n the new retention period. For example, if the data retention period is increased\n from one hour to seven hours, all existing data is retained for seven\n hours.
\nIf the data retention period is decreased, existing data is retained for\n the new retention period. For example, if the data retention period is decreased\n from seven hours to one hour, all existing data is retained for one hour, and\n any data older than one hour is deleted immediately.
\n Increases or decreases the stream's data retention period by the value that you\n specify. To indicate whether you want to increase or decrease the data retention period,\n specify the Operation parameter in the request body. In the request, you\n must specify either the StreamName or the StreamARN.
The retention period that you specify replaces the current value.
\nThis operation requires permission for the\n KinesisVideo:UpdateDataRetention action.
Changing the data retention period affects the data in the stream as\n follows:
\nIf the data retention period is increased, existing data is retained for\n the new retention period. For example, if the data retention period is increased\n from one hour to seven hours, all existing data is retained for seven\n hours.
\nIf the data retention period is decreased, existing data is retained for\n the new retention period. For example, if the data retention period is decreased\n from seven hours to one hour, all existing data is retained for one hour, and\n any data older than one hour is deleted immediately.
\nUpdates the existing signaling channel. This is an asynchronous operation and takes\n time to complete.
\nIf the MessageTtlSeconds value is updated (either increased or reduced),\n it only applies to new messages sent via this channel after it's been updated. Existing\n messages are still expired as per the previous MessageTtlSeconds\n value.
Updates the existing signaling channel. This is an asynchronous operation and takes\n time to complete.
\nIf the MessageTtlSeconds value is updated (either increased or reduced),\n it only applies to new messages sent via this channel after it's been updated. Existing\n messages are still expired as per the previous MessageTtlSeconds\n value.
Updates stream metadata, such as the device name and media type.
\nYou must provide the stream name or the Amazon Resource Name (ARN) of the\n stream.
\nTo make sure that you have the latest version of the stream before updating it, you\n can specify the stream version. Kinesis Video Streams assigns a version to each stream.\n When you update a stream, Kinesis Video Streams assigns a new version number. To get the\n latest stream version, use the DescribeStream API.
\n UpdateStream is an asynchronous operation, and takes time to\n complete.
Updates stream metadata, such as the device name and media type.
\nYou must provide the stream name or the Amazon Resource Name (ARN) of the\n stream.
\nTo make sure that you have the latest version of the stream before updating it, you\n can specify the stream version. Kinesis Video Streams assigns a version to each stream.\n When you update a stream, Kinesis Video Streams assigns a new version number. To get the\n latest stream version, use the DescribeStream API.
\n UpdateStream is an asynchronous operation, and takes time to\n complete.
The name of the stream whose metadata you want to update.
\nThe stream name is an identifier for the stream, and must be unique for each\n account and region.
" + "smithy.api#documentation": "The name of the stream whose metadata you want to update.
\nThe stream name is an identifier for the stream, and must be unique for each\n account and region.
" } }, "StreamARN": { @@ -2626,13 +4748,13 @@ "DeviceName": { "target": "com.amazonaws.kinesisvideo#DeviceName", "traits": { - "smithy.api#documentation": "The name of the device that is writing to the stream.
\nIn the current implementation, Kinesis Video Streams does not use this name.\n
\nThe name of the device that is writing to the stream.
\nIn the current implementation, Kinesis Video Streams does not use this name.\n
\nThe stream's media type. Use MediaType to specify the type of content\n that the stream contains to the consumers of the stream. For more information about\n media types, see Media\n Types. If you choose to specify the MediaType, see Naming\n Requirements.
To play video on the console, you must specify the correct video type. For example,\n if the video in the stream is H.264, specify video/h264 as the\n MediaType.
The stream's media type. Use MediaType to specify the type of content\n that the stream contains to the consumers of the stream. For more information about\n media types, see Media\n Types. If you choose to specify the MediaType, see Naming\n Requirements.
To play video on the console, you must specify the correct video type. For example,\n if the video in the stream is H.264, specify video/h264 as the\n MediaType.
The configuration that consists of the ScheduleExpression and the \n DurationInMinutesdetails that specify the scheduling to record from a camera, or\n local media file, onto the Edge Agent. If the ScheduleExpression is not provided,\n then the Edge Agent will always be in recording mode.
The configuration that consists of the ScheduleConfig attribute that's required, to schedule the jobs \n to upload the recorded media files onto the Edge Agent in a Kinesis Video Stream.\n
True if Amazon Lookout for Vision classifies the image as containing an anomaly, otherwise false.
" } }, @@ -1306,10 +1328,7 @@ "type": "string" }, "com.amazonaws.lookoutvision#Float": { - "type": "float", - "traits": { - "smithy.api#box": {} - } + "type": "float" }, "com.amazonaws.lookoutvision#GreengrassConfiguration": { "type": "structure", @@ -1418,7 +1437,6 @@ "com.amazonaws.lookoutvision#InferenceUnits": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -1453,10 +1471,7 @@ } }, "com.amazonaws.lookoutvision#Integer": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.lookoutvision#InternalServerException": { "type": "structure", @@ -1470,6 +1485,7 @@ "RetryAfterSeconds": { "target": "com.amazonaws.lookoutvision#RetryAfterSeconds", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The period of time, in seconds, before the operation can be retried.
", "smithy.api#httpHeader": "Retry-After" } @@ -1482,10 +1498,7 @@ } }, "com.amazonaws.lookoutvision#IsLabeled": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.lookoutvision#KmsKeyId": { "type": "string", @@ -1940,21 +1953,6 @@ }, "com.amazonaws.lookoutvision#LookoutVisionService": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "LookoutVision", - "arnNamespace": "lookoutvision", - "cloudFormationName": "LookoutVision", - "cloudTrailEventSource": "lookoutvision.amazonaws.com", - "endpointPrefix": "lookoutvision" - }, - "aws.auth#sigv4": { - "name": "lookoutvision" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, \n data types, common parameters, and common errors.
\nAmazon Lookout for Vision enables you to find visual defects in industrial products,\n accurately and at scale. It uses computer vision to identify missing components in an industrial product,\n damage to vehicles or structures, irregularities in production lines, and even minuscule defects in\n silicon wafers — or any other physical item where quality is important such as a missing capacitor\n on printed circuit boards.
", - "smithy.api#title": "Amazon Lookout for Vision" - }, "version": "2020-11-20", "operations": [ { @@ -2023,7 +2021,735 @@ { "target": "com.amazonaws.lookoutvision#UpdateDatasetEntries" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "LookoutVision", + "arnNamespace": "lookoutvision", + "cloudFormationName": "LookoutVision", + "cloudTrailEventSource": "lookoutvision.amazonaws.com", + "endpointPrefix": "lookoutvision" + }, + "aws.auth#sigv4": { + "name": "lookoutvision" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, \n data types, common parameters, and common errors.
\nAmazon Lookout for Vision enables you to find visual defects in industrial products,\n accurately and at scale. It uses computer vision to identify missing components in an industrial product,\n damage to vehicles or structures, irregularities in production lines, and even minuscule defects in\n silicon wafers — or any other physical item where quality is important such as a missing capacitor\n on printed circuit boards.
", + "smithy.api#title": "Amazon Lookout for Vision", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lookoutvision-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, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lookoutvision-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, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lookoutvision.{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://lookoutvision.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutvision.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } }, "com.amazonaws.lookoutvision#ModelArn": { "type": "string" @@ -2131,30 +2857,38 @@ } }, "com.amazonaws.lookoutvision#ModelHostingStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STARTING_HOSTING", - "name": "STARTING_HOSTING" - }, - { - "value": "HOSTED", - "name": "HOSTED" - }, - { - "value": "HOSTING_FAILED", - "name": "HOSTING_FAILED" - }, - { - "value": "STOPPING_HOSTING", - "name": "STOPPING_HOSTING" - }, - { - "value": "SYSTEM_UPDATING", - "name": "SYSTEM_UPDATING" + "type": "enum", + "members": { + "STARTING_HOSTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING_HOSTING" + } + }, + "HOSTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOSTED" + } + }, + "HOSTING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOSTING_FAILED" + } + }, + "STOPPING_HOSTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING_HOSTING" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_UPDATING" } - ] + } } }, "com.amazonaws.lookoutvision#ModelMetadata": { @@ -2385,26 +3119,32 @@ } }, "com.amazonaws.lookoutvision#ModelPackagingJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" } - ] + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.lookoutvision#ModelPackagingJobsList": { @@ -2467,46 +3207,62 @@ } }, "com.amazonaws.lookoutvision#ModelStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRAINING", - "name": "TRAINING" - }, - { - "value": "TRAINED", - "name": "TRAINED" - }, - { - "value": "TRAINING_FAILED", - "name": "TRAINING_FAILED" - }, - { - "value": "STARTING_HOSTING", - "name": "STARTING_HOSTING" - }, - { - "value": "HOSTED", - "name": "HOSTED" - }, - { - "value": "HOSTING_FAILED", - "name": "HOSTING_FAILED" - }, - { - "value": "STOPPING_HOSTING", - "name": "STOPPING_HOSTING" - }, - { - "value": "SYSTEM_UPDATING", - "name": "SYSTEM_UPDATING" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "TRAINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINED" + } + }, + "TRAINING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING_FAILED" + } + }, + "STARTING_HOSTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING_HOSTING" } - ] + }, + "HOSTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOSTED" + } + }, + "HOSTING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOSTING_FAILED" + } + }, + "STOPPING_HOSTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING_HOSTING" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } } }, "com.amazonaws.lookoutvision#ModelStatusMessage": { @@ -2572,7 +3328,6 @@ "com.amazonaws.lookoutvision#PageSize": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -2727,34 +3482,45 @@ } }, "com.amazonaws.lookoutvision#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PROJECT", - "name": "PROJECT" - }, - { - "value": "DATASET", - "name": "DATASET" - }, - { - "value": "MODEL", - "name": "MODEL" - }, - { - "value": "TRIAL", - "name": "TRIAL" - }, - { - "value": "MODEL_PACKAGE_JOB", - "name": "MODEL_PACKAGE_JOB" + "type": "enum", + "members": { + "PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT" + } + }, + "DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET" + } + }, + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL" + } + }, + "TRIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIAL" } - ] + }, + "MODEL_PACKAGE_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_PACKAGE_JOB" + } + } } }, "com.amazonaws.lookoutvision#RetryAfterSeconds": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.lookoutvision#S3BucketName": { "type": "string", @@ -2931,7 +3697,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for\n a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.\n
\n \nUse the DescribeModelPackagingJob API to determine the current status of the job.\n \n The model packaging job is complete if the value of Status is SUCCEEDED.
To deploy the component\n to the target device, use the component name and component version\n with the AWS IoT Greengrass CreateDeployment API.
\n\nThis operation requires the following permissions:
\n\n lookoutvision:StartModelPackagingJob\n
\n s3:PutObject\n
\n s3:GetBucketLocation\n
\n greengrass:CreateComponentVersion\n
\n greengrass:DescribeComponent\n
(Optional) greengrass:TagResource. Only required if you want to tag the component.
For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
", + "smithy.api#documentation": "Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for\n a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.\n
\n \nUse the DescribeModelPackagingJob API to determine the current status of the job.\n \n The model packaging job is complete if the value of Status is SUCCEEDED.
To deploy the component\n to the target device, use the component name and component version\n with the AWS IoT Greengrass CreateDeployment API.
\n\nThis operation requires the following permissions:
\n\n lookoutvision:StartModelPackagingJob\n
\n s3:PutObject\n
\n s3:GetBucketLocation\n
\n kms:GenerateDataKey\n
\n greengrass:CreateComponentVersion\n
\n greengrass:DescribeComponent\n
(Optional) greengrass:TagResource. Only required if you want to tag the component.
For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-11-20/projects/{ProjectName}/modelpackagingjobs", @@ -3274,14 +4040,14 @@ } }, "com.amazonaws.lookoutvision#TargetDevice": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "jetson_xavier", - "name": "JETSON_XAVIER" + "type": "enum", + "members": { + "JETSON_XAVIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_xavier" } - ] + } } }, "com.amazonaws.lookoutvision#TargetPlatform": { @@ -3313,40 +4079,42 @@ } }, "com.amazonaws.lookoutvision#TargetPlatformAccelerator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NVIDIA", - "name": "NVIDIA" + "type": "enum", + "members": { + "NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NVIDIA" } - ] + } } }, "com.amazonaws.lookoutvision#TargetPlatformArch": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ARM64", - "name": "ARM64" - }, - { - "value": "X86_64", - "name": "X86_64" + "type": "enum", + "members": { + "ARM64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARM64" + } + }, + "X86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X86_64" } - ] + } } }, "com.amazonaws.lookoutvision#TargetPlatformOs": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LINUX", - "name": "LINUX" + "type": "enum", + "members": { + "LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX" } - ] + } } }, "com.amazonaws.lookoutvision#ThrottlingException": { @@ -3373,6 +4141,7 @@ "RetryAfterSeconds": { "target": "com.amazonaws.lookoutvision#RetryAfterSeconds", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The period of time, in seconds, before the operation can be retried.
", "smithy.api#httpHeader": "Retry-After" } diff --git a/codegen/sdk-codegen/aws-models/migration-hub-refactor-spaces.json b/codegen/sdk-codegen/aws-models/migration-hub-refactor-spaces.json index d9d870581bd..6fda3151ebc 100644 --- a/codegen/sdk-codegen/aws-models/migration-hub-refactor-spaces.json +++ b/codegen/sdk-codegen/aws-models/migration-hub-refactor-spaces.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "shapes": { "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException": { "type": "structure", @@ -345,10 +345,7 @@ } }, "com.amazonaws.migrationhubrefactorspaces#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.migrationhubrefactorspaces#CidrBlock": { "type": "string" @@ -755,7 +752,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the\n environment owner, regardless of which account creates the route. Routes target a service in\n the application. If an application does not have any routes, then the first route must be\n created as a DEFAULT\n RouteType.
When created, the default route defaults to an active state so state is not a required\n input. However, like all other state values the state of the default route can be updated\n after creation, but only when all other routes are also inactive. Conversely, no route can be\n active without the default route also being active.
\nWhen you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic\n to the target service as follows:
\nIf the service has a URL endpoint, and the endpoint resolves to a private IP address,\n Refactor Spaces routes traffic using the API Gateway VPC link.
\nIf the service has a URL endpoint, and the endpoint resolves to a public IP address,\n Refactor Spaces routes traffic over the public internet.
\nIf the service has an Lambda function endpoint, then Refactor Spaces\n configures the Lambda function's resource policy to allow the application's\n API Gateway to invoke the function.
\nA one-time health check is performed on the service when either the route is updated from\n inactive to active, or when it is created with an active state. If the health check fails, the\n route transitions the route state to FAILED, an error code of\n SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic is sent to\n the service.
For Lambda functions, the Lambda function state is checked. If the\n function is not active, the function configuration is updated so that Lambda\n resources are provisioned. If the Lambda state is Failed, then the\n route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.
For Lambda endpoints, a check is performed to determine that a Lambda function with the\n specified ARN exists. If it does not exist, the health check fails. For public URLs, a\n connection is opened to the public endpoint. If the URL is not reachable, the health check\n fails.
\nFor private URLS, a target group is created on the Elastic Load Balancing and the target\n group health check is run. The HealthCheckProtocol, HealthCheckPort,\n and HealthCheckPath are the same protocol, port, and path specified in the URL or\n health URL, if used. All other settings use the default values, as described in Health checks\n for your target groups. The health check is considered successful if at least one\n target within the target group transitions to a healthy state.
Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed\n certificates are supported. Private Certificate Authorities (CAs) are permitted only if the\n CA's domain is also publicly resolvable.
", + "smithy.api#documentation": "Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the\n environment owner, regardless of which account creates the route. Routes target a service in\n the application. If an application does not have any routes, then the first route must be\n created as a DEFAULT\n RouteType.
When created, the default route defaults to an active state so state is not a required\n input. However, like all other state values the state of the default route can be updated\n after creation, but only when all other routes are also inactive. Conversely, no route can be\n active without the default route also being active.
\nWhen you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic\n to the target service as follows:
\nIf the service has a URL endpoint, and the endpoint resolves to a private IP address,\n Refactor Spaces routes traffic using the API Gateway VPC link.
\nIf the service has a URL endpoint, and the endpoint resolves to a public IP address,\n Refactor Spaces routes traffic over the public internet.
\nIf the service has an Lambda function endpoint, then Refactor Spaces\n configures the Lambda function's resource policy to allow the application's\n API Gateway to invoke the function.
\nA one-time health check is performed on the service when either the route is updated from\n inactive to active, or when it is created with an active state. If the health check fails, the\n route transitions the route state to FAILED, an error code of\n SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic is sent to\n the service.
For Lambda functions, the Lambda function state is checked. If the\n function is not active, the function configuration is updated so that Lambda\n resources are provisioned. If the Lambda state is Failed, then the\n route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.
For Lambda endpoints, a check is performed to determine that a Lambda function with the\n specified ARN exists. If it does not exist, the health check fails. For public URLs, a\n connection is opened to the public endpoint. If the URL is not reachable, the health check\n fails.
\nRefactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in\n CreateServiceRequest$UrlEndpoint when you create a service. The DNS names\n resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60\n seconds. This periodic DNS resolution ensures that the route configuration remains up-to-date.
\nFor private URLS, a target group is created on the Elastic Load Balancing and the target\n group health check is run. The HealthCheckProtocol, HealthCheckPort,\n and HealthCheckPath are the same protocol, port, and path specified in the URL or\n health URL, if used. All other settings use the default values, as described in Health checks\n for your target groups. The health check is considered successful if at least one\n target within the target group transitions to a healthy state.
Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed\n certificates are supported. Private Certificate Authorities (CAs) are permitted only if the\n CA's domain is also publicly resolvable.
", "smithy.api#http": { "method": "POST", "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes", @@ -799,7 +796,7 @@ "DefaultRoute": { "target": "com.amazonaws.migrationhubrefactorspaces#DefaultRouteInput", "traits": { - "smithy.api#documentation": "\n Configuration for the default route type.\n
" + "smithy.api#documentation": "Configuration for the default route type.
" } }, "UriPathRoute": { @@ -988,7 +985,7 @@ "UrlEndpoint": { "target": "com.amazonaws.migrationhubrefactorspaces#UrlEndpointInput", "traits": { - "smithy.api#documentation": "The configuration for the URL endpoint type.
" + "smithy.api#documentation": "The configuration for the URL endpoint type. When creating a route to a service, Refactor Spaces\n automatically resolves the address in the UrlEndpointInput object URL when the\n Domain Name System (DNS) time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60\n seconds.
\n The configuration for the default route type.\n
" + "smithy.api#documentation": "The configuration for the default route type.
" } }, "com.amazonaws.migrationhubrefactorspaces#DeleteApplication": { @@ -2735,7 +2732,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:\n(\\$LATEST|[a-zA-Z0-9-_]+))?$" + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" } }, "com.amazonaws.migrationhubrefactorspaces#LambdaEndpointConfig": { @@ -2758,7 +2755,7 @@ "Arn": { "target": "com.amazonaws.migrationhubrefactorspaces#LambdaArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda endpoint.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function or alias.
", "smithy.api#required": {} } } @@ -3288,7 +3285,6 @@ "com.amazonaws.migrationhubrefactorspaces#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -3448,34 +3444,6 @@ }, "com.amazonaws.migrationhubrefactorspaces#RefactorSpaces": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Migration Hub Refactor Spaces", - "arnNamespace": "refactor-spaces", - "cloudFormationName": "RefactorSpaces", - "cloudTrailEventSource": "refactor-spaces.amazonaws.com", - "endpointPrefix": "refactor-spaces" - }, - "aws.auth#sigv4": { - "name": "refactor-spaces" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "content-type" - ], - "additionalExposedHeaders": [ - "date", - "x-amz-apigw-id", - "x-amzn-trace-id", - "x-amzn-errortype", - "x-amzn-requestid", - "x-amzn-errormessage" - ] - }, - "smithy.api#documentation": "This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services SDKs.
\nTo share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations\n and their OUs, use Resource Access Manager's CreateResourceShare API. See CreateResourceShare in the Amazon Web Services RAM API Reference.
This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services SDKs.
\nTo share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations\n and their OUs, use Resource Access Manager's CreateResourceShare API. See CreateResourceShare in the Amazon Web Services RAM API Reference.
The number of seconds to wait before retrying.
", "smithy.api#httpHeader": "Retry-After" } @@ -4249,7 +4601,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Updates an Amazon Web Services Migration Hub Refactor Spaces route.\n
", + "smithy.api#documentation": "Updates an Amazon Web Services Migration Hub Refactor Spaces route.
", "smithy.api#http": { "method": "PATCH", "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes/{RouteIdentifier}", @@ -4263,7 +4615,7 @@ "EnvironmentIdentifier": { "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", "traits": { - "smithy.api#documentation": "\n The ID of the environment in which the route is being updated.\n
", + "smithy.api#documentation": "The ID of the environment in which the route is being updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4271,7 +4623,7 @@ "ApplicationIdentifier": { "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", "traits": { - "smithy.api#documentation": "\n The ID of the application within which the route is being updated.\n
", + "smithy.api#documentation": "The ID of the application within which the route is being updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4279,7 +4631,7 @@ "RouteIdentifier": { "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", "traits": { - "smithy.api#documentation": "\n The unique identifier of the route to update.\n
", + "smithy.api#documentation": "The unique identifier of the route to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4299,37 +4651,37 @@ "RouteId": { "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", "traits": { - "smithy.api#documentation": "\n The unique identifier of the route.\n
" + "smithy.api#documentation": "The unique identifier of the route.
" } }, "Arn": { "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the route. The format for this ARN is \narn:aws:refactor-spaces:region:account-id:resource-type/resource-id\n . For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference.\n
The Amazon Resource Name (ARN) of the route. The format for this ARN is \narn:aws:refactor-spaces:region:account-id:resource-type/resource-id\n . For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference.
\n The ID of service in which the route was created. Traffic that matches this route is forwarded to this service.\n
" + "smithy.api#documentation": "The ID of service in which the route was created. Traffic that matches this route is\n forwarded to this service.
" } }, "ApplicationId": { "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", "traits": { - "smithy.api#documentation": "\n The ID of the application in which the route is being updated.\n
" + "smithy.api#documentation": "The ID of the application in which the route is being updated.
" } }, "State": { "target": "com.amazonaws.migrationhubrefactorspaces#RouteState", "traits": { - "smithy.api#documentation": "\n The current state of the route.\n
" + "smithy.api#documentation": "The current state of the route.
" } }, "LastUpdatedTime": { "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", "traits": { - "smithy.api#documentation": "\n A timestamp that indicates when the route was last updated.\n
" + "smithy.api#documentation": "A timestamp that indicates when the route was last updated.
" } } } diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index a16339a805d..3b841d31178 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -68,7 +68,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a quota for an Amazon Web Services account.
\nThe following are account quotas:
\n\n AllocatedStorage - The total allocated storage per account, in GiB.\n The used value is the total allocated storage in the account, in GiB.
\n AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. \n The used value is the highest number of ingress rules in a DB security group in the account. Other \n DB security groups in the account might have a lower number of ingress rules.
\n CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. \n The used value is the highest number of custom endpoints in a DB clusters in the account. Other \n DB clusters in the account might have a lower number of custom endpoints.
\n DBClusterParameterGroups - The number of DB cluster parameter groups\n per account, excluding default parameter groups. The used value is the count of\n nondefault DB cluster parameter groups in the account.
\n DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. \n The used value is the highest number of associated IAM roles for a DB cluster in the account. Other \n DB clusters in the account might have a lower number of associated IAM roles.
\n DBClusters - The number of DB clusters per account. \n The used value is the count of DB clusters in the account.
\n DBInstanceRoles - The number of associated IAM roles per DB instance. \n The used value is the highest number of associated IAM roles for a DB instance in the account. Other \n DB instances in the account might have a lower number of associated IAM roles.
\n DBInstances - The number of DB instances per account. \n The used value is the count of the DB instances in the account.
Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB \n instances apply to this quota.
\n\n DBParameterGroups - The number of DB parameter groups per account,\n excluding default parameter groups. The used value is the count of nondefault DB\n parameter groups in the account.
\n DBSecurityGroups - The number of DB security groups (not VPC\n security groups) per account, excluding the default security group. The used\n value is the count of nondefault DB security groups in the account.
\n DBSubnetGroups - The number of DB subnet groups per account. \n The used value is the count of the DB subnet groups in the account.
\n EventSubscriptions - The number of event subscriptions per account. \n The used value is the count of the event subscriptions in the account.
\n ManualClusterSnapshots - The number of manual DB cluster snapshots per account. \n The used value is the count of the manual DB cluster snapshots in the account.
\n ManualSnapshots - The number of manual DB instance snapshots per account. \n The used value is the count of the manual DB instance snapshots in the account.
\n OptionGroups - The number of DB option groups per account, excluding\n default option groups. The used value is the count of nondefault DB option\n groups in the account.
\n ReadReplicasPerMaster - The number of read replicas per DB\n instance. The used value is the highest number of read replicas for a DB\n instance in the account. Other DB instances in the account might have a lower\n number of read replicas.
\n ReservedDBInstances - The number of reserved DB instances per account. \n The used value is the count of the active reserved DB instances in the account.
\n SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. \n The used value is highest number of subnets for a DB subnet group in the account. Other \n DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.
" + "smithy.api#documentation": "Describes a quota for an Amazon Web Services account.
\nThe following are account quotas:
\n\n AllocatedStorage - The total allocated storage per account, in GiB.\n The used value is the total allocated storage in the account, in GiB.
\n AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. \n The used value is the highest number of ingress rules in a DB security group in the account. Other \n DB security groups in the account might have a lower number of ingress rules.
\n CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. \n The used value is the highest number of custom endpoints in a DB clusters in the account. Other \n DB clusters in the account might have a lower number of custom endpoints.
\n DBClusterParameterGroups - The number of DB cluster parameter groups\n per account, excluding default parameter groups. The used value is the count of\n nondefault DB cluster parameter groups in the account.
\n DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. \n The used value is the highest number of associated IAM roles for a DB cluster in the account. Other \n DB clusters in the account might have a lower number of associated IAM roles.
\n DBClusters - The number of DB clusters per account. \n The used value is the count of DB clusters in the account.
\n DBInstanceRoles - The number of associated IAM roles per DB instance. \n The used value is the highest number of associated IAM roles for a DB instance in the account. Other \n DB instances in the account might have a lower number of associated IAM roles.
\n DBInstances - The number of DB instances per account. \n The used value is the count of the DB instances in the account.
Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB \n instances apply to this quota.
\n\n DBParameterGroups - The number of DB parameter groups per account,\n excluding default parameter groups. The used value is the count of nondefault DB\n parameter groups in the account.
\n DBSecurityGroups - The number of DB security groups (not VPC\n security groups) per account, excluding the default security group. The used\n value is the count of nondefault DB security groups in the account.
\n DBSubnetGroups - The number of DB subnet groups per account. \n The used value is the count of the DB subnet groups in the account.
\n EventSubscriptions - The number of event subscriptions per account. \n The used value is the count of the event subscriptions in the account.
\n ManualClusterSnapshots - The number of manual DB cluster snapshots per account. \n The used value is the count of the manual DB cluster snapshots in the account.
\n ManualSnapshots - The number of manual DB instance snapshots per account. \n The used value is the count of the manual DB instance snapshots in the account.
\n OptionGroups - The number of DB option groups per account, excluding\n default option groups. The used value is the count of nondefault DB option\n groups in the account.
\n ReadReplicasPerMaster - The number of read replicas per DB\n instance. The used value is the highest number of read replicas for a DB\n instance in the account. Other DB instances in the account might have a lower\n number of read replicas.
\n ReservedDBInstances - The number of reserved DB instances per account. \n The used value is the count of the active reserved DB instances in the account.
\n SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. \n The used value is highest number of subnets for a DB subnet group in the account. Other \n DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#AccountQuotaList": { @@ -235,7 +235,7 @@ } ], "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.
" } }, "com.amazonaws.rds#AddRoleToDBInstanceMessage": { @@ -297,7 +297,7 @@ "SourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the event source to be added.
\nConstraints:
\nIf the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
The identifier of the event source to be added.
\nConstraints:
\nIf the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
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.
" } }, "com.amazonaws.rds#AddTagsToResourceMessage": { @@ -808,7 +808,7 @@ "name": "rds" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.
\nAmazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.
\nThis interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.
\n\n Amazon RDS API Reference\n
\nFor the alphabetical list of API actions, see \n API Actions.
\nFor the alphabetical list of data types, see \n Data Types.
\nFor a list of common query parameters, see \n Common Parameters.
\nFor descriptions of the error codes, see \n Common Errors.
\n\n Amazon RDS User Guide\n
\nFor a summary of the Amazon RDS interfaces, see \n Available RDS Interfaces.
\nFor more information about how to use the Query API, see \n Using the Query API.
\nAmazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.
\nAmazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.
\nThis interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.
\n\n Amazon RDS API Reference\n
\nFor the alphabetical list of API actions, see \n API Actions.
\nFor the alphabetical list of data types, see \n Data Types.
\nFor a list of common query parameters, see \n Common Parameters.
\nFor descriptions of the error codes, see \n Common Errors.
\n\n Amazon RDS User Guide\n
\nFor a summary of the Amazon RDS interfaces, see \n Available RDS Interfaces.
\nFor more information about how to use the Query API, see \n Using the Query API.
\nThe pending maintenance action to apply to this resource.
\nValid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n
The pending maintenance action to apply to this resource.
\nValid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.
Valid values:
\n\n immediate - Apply the maintenance action immediately.
\n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.
\n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.
Valid values:
\n\n immediate - Apply the maintenance action immediately.
\n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.
\n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.
The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.
\nOr, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.
", + "smithy.api#documentation": "The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.
\nOr, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3228,7 +3228,7 @@ } ], "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.
\nContains Availability Zone information.
\nThis data type is used as an element in the OrderableDBInstanceOption\n data type.
Contains Availability Zone information.
\nThis data type is used as an element in the OrderableDBInstanceOption\n data type.
Contains the available processor feature information for the DB instance class of a DB instance.
\nFor more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n
" + "smithy.api#documentation": "Contains the available processor feature information for the DB instance class of a DB instance.
\nFor more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n
" } }, "com.amazonaws.rds#AvailableProcessorFeatureList": { @@ -3389,7 +3389,7 @@ } ], "traits": { - "smithy.api#documentation": "Backtracks a DB cluster to a specific time, without creating a new DB cluster.
\nFor more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.
\nThis action applies only to Aurora MySQL DB clusters.
\nBacktracks a DB cluster to a specific time, without creating a new DB cluster.
\nFor more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.
\nThis action applies only to Aurora MySQL DB clusters.
\nThe DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
The DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n
\nIf the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.
\nConstraints:
\nMust contain a valid ISO 8601 timestamp.
\nCan't contain a timestamp set in the future.
\nExample: 2017-07-08T18:00Z\n
The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n
\nIf the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.
\nConstraints:
\nMust contain a valid ISO 8601 timestamp.
\nCan't contain a timestamp set in the future.
\nExample: 2017-07-08T18:00Z\n
The source database for the blue/green deployment.
\nBefore switchover, the source database is the production database in the blue environment.
" + "smithy.api#documentation": "The source database for the blue/green deployment.
\nBefore switchover, the source database is the production database in the blue environment.
" } }, "Target": { "target": "com.amazonaws.rds#DatabaseArn", "traits": { - "smithy.api#documentation": "The target database for the blue/green deployment.
\nBefore switchover, the target database is the clone database in the green environment.
" + "smithy.api#documentation": "The target database for the blue/green deployment.
\nBefore switchover, the target database is the clone database in the green environment.
" } }, "SwitchoverDetails": { @@ -3487,7 +3487,7 @@ "Status": { "target": "com.amazonaws.rds#BlueGreenDeploymentStatus", "traits": { - "smithy.api#documentation": "The status of the blue/green deployment.
\nValues:
\n\n PROVISIONING - Resources are being created in the green environment.
\n AVAILABLE - Resources are available in the green environment.
\n SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the \n green environment.
\n SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.
\n INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.
\n SWITCHOVER_FAILED - Switchover was attempted but failed.
\n DELETING - The blue/green deployment is being deleted.
The status of the blue/green deployment.
\nValues:
\n\n PROVISIONING - Resources are being created in the green environment.
\n AVAILABLE - Resources are available in the green environment.
\n SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the \n green environment.
\n SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.
\n INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.
\n SWITCHOVER_FAILED - Switchover was attempted but failed.
\n DELETING - The blue/green deployment is being deleted.
Contains the details about a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "Contains the details about a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" } }, "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault": { @@ -3594,12 +3594,12 @@ "Status": { "target": "com.amazonaws.rds#BlueGreenDeploymentTaskStatus", "traits": { - "smithy.api#documentation": "The status of the blue/green deployment task.
\nValues:
\n\n PENDING - The resources are being prepared for deployment.
\n IN_PROGRESS - The resource is being deployed.
\n COMPLETED - The resource has been deployed.
\n FAILED - Deployment of the resource failed.
The status of the blue/green deployment task.
\nValues:
\n\n PENDING - The resources are being prepared for deployment.
\n IN_PROGRESS - The resource is being deployed.
\n COMPLETED - The resource has been deployed.
\n FAILED - Deployment of the resource failed.
Contains the details about a task for a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "Contains the details about a task for a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" } }, "com.amazonaws.rds#BlueGreenDeploymentTaskList": { @@ -3804,7 +3804,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.
\nThe EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.
\nThe EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#ClusterPendingModifiedValues": { @@ -3866,31 +3866,31 @@ "MaxConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
\nConstraints: Must be between 1 and 100.
" + "smithy.api#documentation": "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
\nConstraints: Must be between 1 and 100.
" } }, "MaxIdleConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent.
Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.
\nDefault: 120
\nConstraints: between 1 and 3600, or 0 representing unlimited
" + "smithy.api#documentation": "The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.
\nDefault: 120
\nConstraints: between 1 and 3600, or 0 representing unlimited
" } }, "SessionPinningFilters": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.
\nDefault: no session pinning filters
" + "smithy.api#documentation": "Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.
\nDefault: no session pinning filters
" } }, "InitQuery": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.
Default: no initialization query
" + "smithy.api#documentation": "One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.
Default: no initialization query
" } } }, @@ -3968,14 +3968,14 @@ "SourceDBClusterParameterGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.
\nConstraints:
\nMust specify a valid DB cluster parameter group.
\nThe identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.
\nConstraints:
\nMust specify a valid DB cluster parameter group.
\nThe identifier for the copied DB cluster parameter group.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster-param-group1\n
The identifier for the copied DB cluster parameter group.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster-param-group1\n
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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { @@ -4037,27 +4037,27 @@ "SourceDBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.
\nYou can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
\nConstraints:
\nMust specify a valid system snapshot in the \"available\" state.
\nIf the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
\nIf the source snapshot is in a different Amazon Web Services Region than the copy,\n specify a valid DB cluster snapshot ARN. For more information, go to\n \n Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
\nExample: my-cluster-snapshot1\n
The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.
\nYou can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
\nConstraints:
\nMust specify a valid system snapshot in the \"available\" state.
\nIf the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
\nIf the source snapshot is in a different Amazon Web Services Region than the copy,\n specify a valid DB cluster snapshot ARN. For more information, go to\n \n Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
\nExample: my-cluster-snapshot1\n
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster-snapshot2\n
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster-snapshot2\n
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
\nIf you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
\nIf you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.
\nThe presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:
\n KmsKeyId - The KMS key identifier for the KMS key\n to use to encrypt the copy of the DB cluster snapshot in the destination\n Amazon Web Services Region. This is the same identifier for both the\n CopyDBClusterSnapshot operation that is called in the\n destination Amazon Web Services Region, and the operation contained in the presigned\n URL.
\n DestinationRegion - The name of the Amazon Web Services Region \n that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To 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.
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.
\nThe presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:
\n KmsKeyId - The KMS key identifier for the KMS key\n to use to encrypt the copy of the DB cluster snapshot in the destination\n Amazon Web Services Region. This is the same identifier for both the\n CopyDBClusterSnapshot operation that is called in the\n destination Amazon Web Services Region, and the operation contained in the presigned\n URL.
\n DestinationRegion - The name of the Amazon Web Services Region \n that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To 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.
The identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
\nConstraints:
\nMust specify a valid DB parameter group.
\nThe identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
\nConstraints:
\nMust specify a valid DB parameter group.
\nThe identifier for the copied DB parameter group.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-db-parameter-group\n
The identifier for the copied DB parameter group.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-db-parameter-group\n
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.
" } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { @@ -4183,21 +4183,21 @@ "SourceDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier for the source DB snapshot.
\nIf the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
\nIf you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
\nConstraints:
\nMust specify a valid system snapshot in the \"available\" state.
\nExample: rds:mydb-2012-04-02-00-01\n
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n
The identifier for the source DB snapshot.
\nIf the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
\nIf you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
\nConstraints:
\nMust specify a valid system snapshot in the \"available\" state.
\nExample: rds:mydb-2012-04-02-00-01\n
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n
The identifier for the copy of the snapshot.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-db-snapshot\n
The identifier for the copy of the snapshot.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-db-snapshot\n
The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.
\nIf you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.
\nIf you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.
\nIf you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.
\nIf you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.
\nIf you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.
\nIf you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.
" } }, "Tags": { @@ -4206,25 +4206,31 @@ "CopyTags": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.
" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.
\nYou must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted DB\n snapshot is copied to. This Amazon Web Services Region is the same one where the\n CopyDBSnapshot operation is called that contains this presigned\n URL.
For example, if you copy an encrypted DB snapshot from the us-west-2\n Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the\n CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and\n provide a presigned URL that contains a call to the CopyDBSnapshot\n operation in the us-west-2 Amazon Web Services Region. For this example, the\n DestinationRegion in the presigned URL must be set to the\n us-east-1 Amazon Web Services Region.
\n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the\n same identifier for both the CopyDBSnapshot operation that is\n called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.
\n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\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.
When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.
\nYou must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted DB\n snapshot is copied to. This Amazon Web Services Region is the same one where the\n CopyDBSnapshot operation is called that contains this presigned\n URL.
For example, if you copy an encrypted DB snapshot from the us-west-2\n Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the\n CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and\n provide a presigned URL that contains a call to the CopyDBSnapshot\n operation in the us-west-2 Amazon Web Services Region. For this example, the\n DestinationRegion in the presigned URL must be set to the\n us-east-1 Amazon Web Services Region.
\n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the\n same identifier for both the CopyDBSnapshot operation that is\n called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.
\n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\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.
The name of an option group to associate with the copy of the snapshot.
\nSpecify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The name of an option group to associate with the copy of the snapshot.
\nSpecify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.
" } }, "TargetCustomAvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The external custom Availability Zone (CAZ) identifier for the target CAZ.
\nExample: rds-caz-aiqhTgQv.
The external custom Availability Zone (CAZ) identifier for the target CAZ.
\nExample: rds-caz-aiqhTgQv.
A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.
" } } }, @@ -4269,14 +4275,14 @@ "SourceOptionGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier for the source option group.
\nConstraints:
\nMust specify a valid option group.
\nThe identifier for the source option group.
\nConstraints:
\nMust specify a valid option group.
\nThe identifier for the copied option group.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-option-group\n
The identifier for the copied option group.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-option-group\n
Creates a blue/green deployment.
\nA blue/green deployment creates a staging environment that copies the production environment. \n In a blue/green deployment, the blue environment is the current production environment. \n The green environment is the staging environment. The staging environment stays in sync \n with the current production environment using logical replication.
\nYou can make changes to the databases in the green environment without affecting \n production workloads. For example, you can upgrade the major or minor DB engine version, change \n database parameters, or make schema changes in the staging environment. You can thoroughly test \n changes in the green environment. When ready, you can switch over the environments to promote the \n green environment to be the new production environment. The switchover typically takes under a minute.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "Creates a blue/green deployment.
\nA blue/green deployment creates a staging environment that copies the production environment. \n In a blue/green deployment, the blue environment is the current production environment. \n The green environment is the staging environment. The staging environment stays in sync \n with the current production environment using logical replication.
\nYou can make changes to the databases in the green environment without affecting \n production workloads. For example, you can upgrade the major or minor DB engine version, change \n database parameters, or make schema changes in the staging environment. You can thoroughly test \n changes in the green environment. When ready, you can switch over the environments to promote the \n green environment to be the new production environment. The switchover typically takes under a minute.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" } }, "com.amazonaws.rds#CreateBlueGreenDeploymentRequest": { @@ -4356,33 +4362,33 @@ "BlueGreenDeploymentName": { "target": "com.amazonaws.rds#BlueGreenDeploymentName", "traits": { - "smithy.api#documentation": "The name of the blue/green deployment.
\nConstraints:
\nCan't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
\nThe name of the blue/green deployment.
\nConstraints:
\nCan't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
\nThe Amazon Resource Name (ARN) of the source production database.
\nSpecify the database that you want to clone. The blue/green deployment creates this database in \n the green environment. You can make updates to the database in the green environment, such as an engine \n version upgrade. When you are ready, you can switch the database in the green environment to be the \n production database.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source production database.
\nSpecify the database that you want to clone. The blue/green deployment creates this database in \n the green environment. You can make updates to the database in the green environment, such as an engine \n version upgrade. When you are ready, you can switch the database in the green environment to be the \n production database.
", "smithy.api#required": {} } }, "TargetEngineVersion": { "target": "com.amazonaws.rds#TargetEngineVersion", "traits": { - "smithy.api#documentation": "The engine version of the database in the green environment.
\nSpecify the engine version to upgrade to in the green environment.
" + "smithy.api#documentation": "The engine version of the database in the green environment.
\nSpecify the engine version to upgrade to in the green environment.
" } }, "TargetDBParameterGroupName": { "target": "com.amazonaws.rds#TargetDBParameterGroupName", "traits": { - "smithy.api#documentation": "The DB parameter group associated with the DB instance in the green environment.
\nTo test parameter changes, specify a DB parameter group that is different from the one associated \n with the source DB instance.
" + "smithy.api#documentation": "The DB parameter group associated with the DB instance in the green environment.
\nTo test parameter changes, specify a DB parameter group that is different from the one associated \n with the source DB instance.
" } }, "TargetDBClusterParameterGroupName": { "target": "com.amazonaws.rds#TargetDBClusterParameterGroupName", "traits": { - "smithy.api#documentation": "The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
\nTo test parameter changes, specify a DB cluster parameter group that is different from the one associated \n with the source DB cluster.
" + "smithy.api#documentation": "The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
\nTo test parameter changes, specify a DB cluster parameter group that is different from the one associated \n with the source DB cluster.
" } }, "Tags": { @@ -4421,7 +4427,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The supported engines are the following:
\nOracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR
\nOracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR
\nAmazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.
\nWhen you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
\nCreation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.
For more information, see \n Creating a CEV in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The supported engines are the following:
\nOracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR
\nOracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR
\nAmazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.
\nWhen you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
\nCreation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.
For more information, see \n Creating a CEV in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { @@ -4457,7 +4463,7 @@ "KMSKeyId": { "target": "com.amazonaws.rds#KmsKeyIdOrArn", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.
\nIf you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.
\nYou can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
", + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.
\nIf you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.
\nYou can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
", "smithy.api#required": {} } }, @@ -4470,7 +4476,7 @@ "Manifest": { "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", "traits": { - "smithy.api#documentation": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.
\nThe following JSON fields are valid:
\nVersion of the CEV manifest. The date is in the format YYYY-MM-DD.
Ordered list of installation files for the CEV.
\nOrdered list of OPatch installers used for the Oracle DB engine.
\nThe PSU and RU patches for this CEV.
\nThe patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.
\nFor more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.
", + "smithy.api#documentation": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.
\nThe following JSON fields are valid:
\nVersion of the CEV manifest. The date is in the format YYYY-MM-DD.
Ordered list of installation files for the CEV.
\nOrdered list of OPatch installers used for the Oracle DB engine.
\nThe PSU and RU patches for this CEV.
\nThe patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.
\nFor more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.
", "smithy.api#required": {} } }, @@ -4544,7 +4550,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
\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 MySQL or\n PostgreSQL DB instance.
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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
\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 MySQL or\n PostgreSQL DB instance.
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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CreateDBClusterEndpoint": { @@ -4576,7 +4582,7 @@ } ], "traits": { - "smithy.api#documentation": "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.
\nA list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
\nFor information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
\nFor information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which automated backups are retained.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The number of days for which automated backups are retained.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified CharacterSet.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified CharacterSet.
\nValid for: Aurora DB clusters only
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB cluster identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The DB cluster identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A DB subnet group to associate with this DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A DB subnet group to associate with this DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the database engine to be used for this DB cluster.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The name of the database engine to be used for this DB cluster.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to use.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.
\n\n Aurora PostgreSQL\n
\nFor information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The version number of the database engine to use.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.
\n\n Aurora PostgreSQL\n
\nFor information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the instances in the DB cluster accept connections.
\n\n RDS for MySQL and Aurora MySQL\n
\nDefault: 3306\n
Valid values: 1150-65535\n
\n RDS for PostgreSQL and Aurora PostgreSQL\n
\nDefault: 5432\n
Valid values: 1150-65535\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The port number on which the instances in the DB cluster accept connections.
\n\n RDS for MySQL and Aurora MySQL\n
\nDefault: 3306\n
Valid values: 1150-65535\n
\n RDS for PostgreSQL and Aurora PostgreSQL\n
\nDefault: 5432\n
Valid values: 1150-65535\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the master user for the DB cluster.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the master user for the DB cluster.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group.
\nDB clusters are associated with a default option group that can't be modified.
" + "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "ReplicationSourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.
\nValid for: Aurora DB clusters only
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "Tags to assign to the DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Tags to assign to the DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster is encrypted.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether the DB cluster is encrypted.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\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.
\nWhen a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the KMS key used to encrypt the\n source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default 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.
\nIf you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\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.
\nWhen a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the KMS key used to encrypt the\n source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default 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.
\nIf you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.
The presigned URL request must contain the following parameter values:
\n\n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To 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.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.
The presigned URL request must contain the following parameter values:
\n\n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To 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.
Valid for: Aurora DB clusters only
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" + "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.
\nValid for: Aurora DB clusters only
" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to create the DB cluster in.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
\nFor more information, see Kerberos authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB cluster in.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
\nFor more information, see Kerberos authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
\nValid for: Aurora DB clusters only
" } }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid values: io1\n
When specified, a value for the Iops parameter is required.
Default: io1\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid values: io1\n
When specified, a value for the Iops parameter is required.
Default: io1\n
Valid for: Multi-AZ DB clusters only
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nThis setting is required to create a Multi-AZ DB cluster.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nThis setting is required to create a Multi-AZ DB cluster.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nValid for: Multi-AZ DB clusters only
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Multi-AZ DB clusters only
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for: Multi-AZ DB clusters only
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nValid for: Multi-AZ DB clusters only
" } }, "ServerlessV2ScalingConfiguration": { @@ -4898,7 +4904,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "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
" + "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
" } }, "DBSystemId": { @@ -4929,7 +4935,7 @@ } ], "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { @@ -4938,14 +4944,14 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster parameter group.
\nConstraints:
\nMust not match the name of an existing DB cluster parameter group.
\nThis value is stored as a lowercase string.
\nThe name of the DB cluster parameter group.
\nConstraints:
\nMust not match the name of an existing DB cluster parameter group.
\nThis value is stored as a lowercase string.
\nThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
\n\n Aurora MySQL\n
\nExample: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\n
\n Aurora PostgreSQL\n
\nExample: aurora-postgresql9.6\n
\n RDS for MySQL\n
\nExample: mysql8.0\n
\n RDS for PostgreSQL\n
\nExample: postgres12\n
To list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
\n\n Aurora MySQL\n
\nExample: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\n
\n Aurora PostgreSQL\n
\nExample: aurora-postgresql9.6\n
\n RDS for MySQL\n
\nExample: mysql8.0\n
\n RDS for PostgreSQL\n
\nExample: postgres12\n
To list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { @@ -5018,14 +5024,14 @@ "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1-snapshot1\n
The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1-snapshot1\n
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nExample: my-cluster1\n
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nExample: my-cluster1\n
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.
" } }, "com.amazonaws.rds#CreateDBInstanceMessage": { @@ -5128,20 +5134,20 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n Amazon RDS Custom for Oracle\n
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.
Default: ORCL\n
Constraints:
\nIt must contain 1 to 8 alphanumeric characters.
\nIt must contain a letter.
\nIt can't be a word reserved by the database engine.
\n\n Amazon RDS Custom for SQL Server\n
\nNot applicable. Must be null.
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n Amazon RDS Custom for Oracle\n
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.
Default: ORCL\n
Constraints:
\nIt must contain 1 to 8 alphanumeric characters.
\nIt must contain a letter.
\nIt can't be a word reserved by the database engine.
\n\n Amazon RDS Custom for SQL Server\n
\nNot applicable. Must be null.
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe DB instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The DB instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nType: Integer
\n\n Amazon Aurora\n
\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\n\n Amazon RDS Custom\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\n\n MySQL\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n MariaDB\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n PostgreSQL\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n Oracle\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\n\n SQL Server\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3):
\nEnterprise and Standard editions: Must be an integer from 20 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 100 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 20 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nType: Integer
\n\n Amazon Aurora\n
\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\n\n Amazon RDS Custom\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\n\n MySQL\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n MariaDB\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n PostgreSQL\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n Oracle\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\n\n SQL Server\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3):
\nEnterprise and Standard editions: Must be an integer from 20 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 100 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 20 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe name of the database engine to be used for this instance.
\nNot every database engine is available for every Amazon Web Services Region.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n custom-oracle-ee (for RDS Custom for Oracle instances)\n
\n custom-sqlserver-ee (for RDS Custom for SQL Server instances)\n
\n custom-sqlserver-se (for RDS Custom for SQL Server instances)\n
\n custom-sqlserver-web (for RDS Custom for SQL Server instances)\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the database engine to be used for this instance.
\nNot every database engine is available for every Amazon Web Services Region.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n custom-oracle-ee (for RDS Custom for Oracle instances)\n
\n custom-sqlserver-ee (for RDS Custom for SQL Server instances)\n
\n custom-sqlserver-se (for RDS Custom for SQL Server instances)\n
\n custom-sqlserver-web (for RDS Custom for SQL Server instances)\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name for the master user.
\n\n Amazon Aurora\n
\nNot applicable. The name for the master user is managed by the DB cluster.
\n\n Amazon RDS\n
\nConstraints:
\nRequired.
\nMust be 1 to 16 letters, numbers, or underscores.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe name for the master user.
\n\n Amazon Aurora\n
\nNot applicable. The name for the master user is managed by the DB cluster.
\n\n Amazon RDS\n
\nConstraints:
\nRequired.
\nMust be 1 to 16 letters, numbers, or underscores.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB\n cluster.
\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
" + "smithy.api#documentation": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB\n cluster.
\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
" } }, "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "A list of DB security groups to associate with this DB instance.
\nThis setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.
A list of DB security groups to associate with this DB instance.
\nThis setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.
A list of Amazon EC2 VPC security groups to associate with this DB instance.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" + "smithy.api#documentation": "A list of Amazon EC2 VPC security groups to associate with this DB instance.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.
\n\n Amazon Aurora\n
\nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.
\n\n Amazon Aurora\n
\nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
A DB subnet group to associate with this DB instance.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" + "smithy.api#documentation": "The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nIt must be 1 to 255 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nIt can't end with a hyphen or contain two consecutive hyphens.
\nThe name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nIt must be 1 to 255 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nIt can't end with a hyphen or contain two consecutive hyphens.
\nThe number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.
\n\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\nCan't be set to 0 for an RDS Custom for Oracle DB instance
\nThe number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.
\n\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\nCan't be set to 0 for an RDS Custom for Oracle DB instance
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
\n Amazon Aurora\n
\nNot applicable. The daily time range for creating automated backups is managed by\n the DB cluster.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
\n Amazon Aurora\n
\nNot applicable. The daily time range for creating automated backups is managed by\n the DB cluster.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe port number on which the database accepts connections.
\n\n MySQL\n
\nDefault: 3306\n
Valid values: 1150-65535\n
Type: Integer
\n\n MariaDB\n
\nDefault: 3306\n
Valid values: 1150-65535\n
Type: Integer
\n\n PostgreSQL\n
\nDefault: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\nDefault: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\nDefault: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\nDefault: 3306\n
Valid values: 1150-65535\n
Type: Integer
" + "smithy.api#documentation": "The port number on which the database accepts connections.
\n\n MySQL\n
\nDefault: 3306\n
Valid values: 1150-65535\n
Type: Integer
\n\n MariaDB\n
\nDefault: 3306\n
Valid values: 1150-65535\n
Type: Integer
\n\n PostgreSQL\n
\nDefault: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\nDefault: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\nDefault: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\nDefault: 3306\n
Valid values: 1150-65535\n
Type: Integer
" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions\n operation.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n\n Amazon RDS Custom for Oracle\n
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
\n Amazon RDS Custom for SQL Server\n
\nSee RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.
\n\n MariaDB\n
\nFor information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Microsoft SQL Server\n
\nFor information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Oracle\n
\nFor information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.
" + "smithy.api#documentation": "The version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions\n operation.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n\n Amazon RDS Custom for Oracle\n
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
\n Amazon RDS Custom for SQL Server\n
\nSee RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.
\n\n MariaDB\n
\nFor information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Microsoft SQL Server\n
\nFor information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Oracle\n
\nFor information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nIf you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nIf you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.
License model information for this DB instance.
\nValid values: license-included | bring-your-own-license | general-public-license\n
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" + "smithy.api#documentation": "License model information for this DB instance.
\nValid values: license-included | bring-your-own-license | general-public-license\n
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.
\nConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.
\n\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.
\nConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.
\n\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the DB instance should be associated with the specified option group.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" + "smithy.api#documentation": "A value that indicates that the DB instance should be associated with the specified option group.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "For supported engines, this value indicates that the DB instance should be associated with the \n specified CharacterSet.
This setting doesn't apply to RDS Custom. However, if you need to change the character set, \n you can change it on the database itself.
\n\n Amazon Aurora\n
\nNot applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.
For supported engines, this value indicates that the DB instance should be associated with the \n specified CharacterSet.
This setting doesn't apply to RDS Custom. However, if you need to change the character set, \n you can change it on the database itself.
\n\n Amazon Aurora\n
\nNot applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.
The name of the NCHAR character set for the Oracle DB instance.
\nThis parameter doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The name of the NCHAR character set for the Oracle DB instance.
\nThis parameter doesn't apply to RDS Custom.
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
\nA value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
\nThe identifier of the DB cluster that the instance will belong to.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The identifier of the DB cluster that the instance will belong to.
\nThis setting doesn't apply to RDS Custom.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" + "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
\nFor RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.
\n Amazon Aurora\n
\nNot applicable. The encryption for DB instances is managed by the DB cluster.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
\nFor RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.
\n Amazon Aurora\n
\nNot applicable. The encryption for DB instances is managed by the DB cluster.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted 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.
\n\n Amazon Aurora\n
\nNot applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
\n Amazon RDS Custom\n
\nA KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.
The Amazon Web Services KMS key identifier for an encrypted 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.
\n\n Amazon Aurora\n
\nNot applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
\n Amazon RDS Custom\n
\nA KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The domain is managed by the DB cluster.
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The domain is managed by the DB cluster.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.
" + "smithy.api#documentation": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The domain is managed by the DB cluster.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The domain is managed by the DB cluster.
" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom.
\nDefault: 1
\nValid Values: 0 - 15
" + "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom.
\nDefault: 1
\nValid Values: 0 - 15
" } }, "Timezone": { @@ -5365,79 +5371,79 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\n\n Amazon Aurora\n
\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.
\n\n RDS Custom\n
\nNot applicable.
\n\n MariaDB\n
\nPossible values are audit, error, general, and slowquery.
\n Microsoft SQL Server\n
\nPossible values are agent and error.
\n MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Oracle\n
\nPossible values are alert, audit, listener, trace, and\n oemagent.
\n PostgreSQL\n
\nPossible values are postgresql and upgrade.
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\n\n Amazon Aurora\n
\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.
\n\n RDS Custom\n
\nNot applicable.
\n\n MariaDB\n
\nPossible values are audit, error, general, and slowquery.
\n Microsoft SQL Server\n
\nPossible values are agent and error.
\n MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Oracle\n
\nPossible values are alert, audit, listener, trace, and\n oemagent.
\n PostgreSQL\n
\nPossible values are postgresql and upgrade.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
\n\n Amazon Aurora\n
\nNot applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.
A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
\n\n Amazon Aurora\n
\nNot applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" } }, "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
" } } }, @@ -5516,7 +5522,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas 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 DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.
\nYour source DB instance must have backup retention enabled.
\nCreates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas 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 DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.
\nYour source DB instance must have backup retention enabled.
\nThe identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.
\nConstraints:
\nMust be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.
\nCan specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.
\nFor the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.
\nFor the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
\nCan specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-Region replication).
\nThe specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.
\nIf the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.
\nIf the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support \n cross-Region replicas.
\nThe identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.
\nConstraints:
\nMust be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.
\nCan specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.
\nFor the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.
\nFor the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
\nCan specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-Region replication).
\nThe specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.
\nIf the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.
\nIf the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support \n cross-Region replicas.
\nThe compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.
\nDefault: Inherits from the source DB instance.
" + "smithy.api#documentation": "The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.
\nDefault: Inherits from the source DB instance.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Availability Zone (AZ) where the read replica will be created.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
The Availability Zone (AZ) where the read replica will be created.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
The port number that the DB instance uses for connections.
\nDefault: Inherits from the source DB instance
\nValid Values: 1150-65535\n
The port number that the DB instance uses for connections.
\nDefault: Inherits from the source DB instance
\nValid Values: 1150-65535\n
A value that indicates whether the read replica is in a Multi-AZ deployment.
\nYou can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the read replica is in a Multi-AZ deployment.
\nYou can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Inherits from the source DB instance
" + "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Inherits from the source DB instance
" } }, "Iops": { @@ -5575,19 +5581,19 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
\nFor SQL Server, you must use the option group associated with the source\n instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
\nFor SQL Server, you must use the option group associated with the source\n instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.
\nConstraints:
\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
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.
\nConstraints:
\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 the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "Tags": { @@ -5596,19 +5602,19 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
\nConstraints:
\nCan only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.
\nIf supplied, must match the name of an existing DBSubnetGroup.
\nThe specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
\nAll read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:>
\nSpecify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.
\nNot specify a DB subnet group. All these read replicas are created outside of any\n VPC.
\nExample: mydbsubnetgroup\n
Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
\nConstraints:
\nCan only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.
\nIf supplied, must match the name of an existing DBSubnetGroup.
\nThe specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
\nAll read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:>
\nSpecify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.
\nNot specify a DB subnet group. All these read replicas are created outside of any\n VPC.
\nExample: mydbsubnetgroup\n
A list of Amazon EC2 VPC security groups to associate with the read replica.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" + "smithy.api#documentation": "A list of Amazon EC2 VPC security groups to associate with the read replica.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the read replica.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Specifies the storage type to be associated with the read replica.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted read replica.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region\n is always encrypted with the same KMS key as the source DB instance.
\nIf you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.
\nYou can't create an encrypted read replica from an unencrypted DB instance.
\nThis setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted read replica.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region\n is always encrypted with the same KMS key as the source DB instance.
\nIf you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.
\nYou can't create an encrypted read replica from an unencrypted DB instance.
\nThis setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.
" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
\nYou must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.
\n KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\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.
\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
\nYou must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.
\n KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\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.
\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the read replica.
\nFor more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the read replica.
\nFor more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\n \nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DeletionProtection": { @@ -5692,43 +5698,43 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "The open mode of the replica database: mounted or read-only.
\nThis parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.
\nYou can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
\nFor RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.
The open mode of the replica database: mounted or read-only.
\nThis parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.
\nYou can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
\nFor RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" } }, "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for read replica. \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 RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for read replica. \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 RDS User Guide.\n
" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the storage throughput value for the read replica.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "Specifies the storage throughput value for the read replica.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" } } } @@ -5766,7 +5772,7 @@ } ], "traits": { - "smithy.api#documentation": "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 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.
The name of the DB parameter group.
\nConstraints:
\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
\nThis value is stored as a lowercase string.
\nThe name of the DB parameter group.
\nConstraints:
\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
\nThis value is stored as a lowercase string.
\nThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
\nTo list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
\nTo list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
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.
\nThe name for the DB security group. This value is stored as a lowercase string.
\nConstraints:
\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
\nMust not be \"Default\"
\nExample: mysecuritygroup\n
The name for the DB security group. This value is stored as a lowercase string.
\nConstraints:
\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
\nMust not be \"Default\"
\nExample: mysecuritygroup\n
The identifier for the DB snapshot.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
The identifier for the DB snapshot.
\nConstraints:
\nCan't be null, empty, or blank
\nMust contain from 1 to 255 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
The identifier of the DB instance that you want to create the snapshot of.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe identifier of the DB instance that you want to create the snapshot of.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe name for the DB subnet group. This value is stored as a lowercase string.
\nConstraints:
\nMust contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
\nMust not be default.
\nFirst character must be a letter.
\nExample: mydbsubnetgroup\n
The name for the DB subnet group. This value is stored as a lowercase string.
\nConstraints:
\nMust contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
\nMust not be default.
\nFirst character must be a letter.
\nExample: mydbsubnetgroup\n
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.
" } }, "com.amazonaws.rds#CreateEventSubscriptionMessage": { @@ -6230,7 +6236,7 @@ "SubscriptionName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the subscription.
\nConstraints: The name must be less than 255 characters.
", + "smithy.api#documentation": "The name of the subscription.
\nConstraints: The name must be less than 255 characters.
", "smithy.api#required": {} } }, @@ -6244,19 +6250,19 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source type 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 .\n You can also see this list by using the DescribeEventCategories operation.
A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source type 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 .\n You can also see this list by using the DescribeEventCategories operation.
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
\nConstraints:
\nIf SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
\nConstraints:
\nIf SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
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 add a primary cluster and a secondary cluster to it.\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 action 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 add a primary cluster and a secondary cluster to it.\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 action applies only to Aurora DB clusters.
\nCreates 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.
" } }, "com.amazonaws.rds#CreateOptionGroupMessage": { @@ -6388,14 +6394,14 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the name of the option group to be created.
\nConstraints:
\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
\nExample: myoptiongroup\n
Specifies the name of the option group to be created.
\nConstraints:
\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
\nExample: myoptiongroup\n
Specifies the name of the engine that this option group should be associated with.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Specifies the name of the engine that this option group should be associated with.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
\nIf a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.
" + "smithy.api#documentation": "The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
\nIf a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.
" } }, "CustomEndpoints": { @@ -6740,7 +6746,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" + "smithy.api#documentation": "If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "DbClusterResourceId": { @@ -6800,19 +6806,19 @@ "EnabledCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "A list of log types that this DB cluster is configured to export to CloudWatch Logs.
\nLog types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "A list of log types that this DB cluster is configured to export to CloudWatch Logs.
\nLog types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n
" } }, "Capacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.
\nFor more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.
" + "smithy.api#documentation": "The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.
\nFor more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.
For more information, see \n CreateDBCluster.
" + "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.
For more information, see \n CreateDBCluster.
" } }, "ScalingConfigurationInfo": { @@ -6827,7 +6833,7 @@ "HttpEndpointEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
" + "smithy.api#documentation": "A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
" } }, "ActivityStreamMode": { @@ -6845,7 +6851,7 @@ "ActivityStreamKmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "ActivityStreamKinesisStreamName": { @@ -6896,62 +6902,62 @@ "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the compute and memory capacity class of the DB instance.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The name of the compute and memory capacity class of the DB instance.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "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.
" + "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 Provisioned IOPS (I/O operations per second) value.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The Provisioned IOPS (I/O operations per second) value.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies the accessibility options for the DB instance.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private \n IP address from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "Specifies the accessibility options for the DB instance.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private \n IP address from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates that minor version patches are applied automatically.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "A value that indicates that minor version patches are applied automatically.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "PerformanceInsightsEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "True if Performance Insights is enabled for the DB cluster, and otherwise false.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "True if Performance Insights is enabled for the DB cluster, and otherwise false.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "ServerlessV2ScalingConfiguration": { @@ -6960,7 +6966,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\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
\nThis setting is only for Aurora DB clusters.
" + "smithy.api#documentation": "The network type of the DB instance.
\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
\nThis setting is only for Aurora DB clusters.
" } }, "DBSystemId": { @@ -6971,7 +6977,7 @@ } }, "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": { @@ -7027,7 +7033,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The status of the backtrack. This property returns one of the following\n values:
\n\n applying - The backtrack is currently being applied to or rolled back from the DB cluster.
\n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
\n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
\n pending - The backtrack is currently pending application to or rollback from the DB cluster.
The status of the backtrack. This property returns one of the following\n values:
\n\n applying - The backtrack is currently being applied to or rolled back from the DB cluster.
\n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
\n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
\n pending - The backtrack is currently pending application to or rollback from the DB cluster.
This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:
\n\n CreateDBClusterEndpoint\n
\n DescribeDBClusterEndpoints\n
\n ModifyDBClusterEndpoint\n
\n DeleteDBClusterEndpoint\n
For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.
This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:
\n\n CreateDBClusterEndpoint\n
\n DescribeDBClusterEndpoints\n
\n ModifyDBClusterEndpoint\n
\n DeleteDBClusterEndpoint\n
For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.
Contains the details of an Amazon RDS DB cluster parameter group.
\nThis data type is used as a response element in the DescribeDBClusterParameterGroups action.
Contains the details of an Amazon RDS DB cluster parameter group.
\nThis data type is used as a response element in the DescribeDBClusterParameterGroups action.
The name of the DB cluster parameter group.
\nConstraints:
\nMust be 1 to 255 letters or numbers.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThis value is stored as a lowercase string.
\nThe name of the DB cluster parameter group.
\nConstraints:
\nMust be 1 to 255 letters or numbers.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThis value is stored as a lowercase string.
\nDescribes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:
\n\n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other Amazon Web Services on your behalf.
\n PENDING - the IAM role ARN is being associated with the DB cluster.
\n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other Amazon Web Services on your behalf.
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:
\n\n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other Amazon Web Services on your behalf.
\n PENDING - the IAM role ARN is being associated with the DB cluster.
\n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other Amazon Web Services on your behalf.
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
\n\n available\n
\n copying\n
\n creating\n
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
\n\n available\n
\n copying\n
\n creating\n
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" + "smithy.api#documentation": "If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "DBClusterSnapshotArn": { @@ -7748,7 +7754,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the details for an Amazon RDS DB cluster snapshot
\nThis data type is used as a response element \n in the DescribeDBClusterSnapshots action.
Contains the details for an Amazon RDS DB cluster snapshot
\nThis data type is used as a response element \n in the DescribeDBClusterSnapshots action.
The name of the manual DB cluster snapshot attribute.
\nThe attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.
The name of the manual DB cluster snapshot attribute.
\nThe attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.
The value(s) for the manual DB cluster snapshot attribute.
\nIf the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any Amazon Web Services account to copy or restore.
The value(s) for the manual DB cluster snapshot attribute.
\nIf the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any Amazon Web Services account to copy or restore.
Contains the name and values of a manual DB cluster snapshot attribute.
\nManual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.
Contains the name and values of a manual DB cluster snapshot attribute.
\nManual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.
Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.
Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.
A list of features supported by the DB engine.
\nThe supported features vary by DB engine and DB engine version.
\nTo determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:
\n\n aws rds describe-db-engine-versions --engine \n
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n
The supported features are listed under SupportedFeatureNames in the output.
A list of features supported by the DB engine.
\nThe supported features vary by DB engine and DB engine version.
\nTo determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:
\n\n aws rds describe-db-engine-versions --engine \n
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n
The supported features are listed under SupportedFeatureNames in the output.
Specifies the current state of this database.
\nFor information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Specifies the current state of this database.
\nFor information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n
" } }, "AutomaticRestartTime": { @@ -8106,13 +8112,13 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The meaning of this parameter differs according to the database engine you use.
\n\n MySQL, MariaDB, SQL Server, PostgreSQL\n
\nContains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
\nType: String
\n\n Oracle\n
\nContains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
" + "smithy.api#documentation": "The meaning of this parameter differs according to the database engine you use.
\n\n MySQL, MariaDB, SQL Server, PostgreSQL\n
\nContains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
\nType: String
\n\n Oracle\n
\nContains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
" } }, "Endpoint": { "target": "com.amazonaws.rds#Endpoint", "traits": { - "smithy.api#documentation": "Specifies the connection endpoint.
\nThe endpoint might not be shown for instances whose status is creating.
Specifies the connection endpoint.
\nThe endpoint might not be shown for instances whose status is creating.
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.
\nCurrently, each RDS DB instance can have only one Aurora read replica.
\nContains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.
\nCurrently, each RDS DB instance can have only one Aurora read replica.
\nThe open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
\nThe open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
\nSpecifies the accessibility options for the DB instance.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "Specifies the accessibility options for the DB instance.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "StatusInfos": { @@ -8317,7 +8323,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" + "smithy.api#documentation": "If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "DbiResourceId": { @@ -8342,7 +8348,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
\nIAM database authentication can be enabled for the following database engines
\nFor MySQL 5.6, minor version 5.6.34 or higher
\nFor MySQL 5.7, minor version 5.7.16 or higher
\nAurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
\nTrue if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
\nIAM database authentication can be enabled for the following database engines
\nFor MySQL 5.6, minor version 5.6.34 or higher
\nFor MySQL 5.7, minor version 5.7.16 or higher
\nAurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
\nThe Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nThe number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nA list of log types that this DB instance is configured to export to CloudWatch Logs.
\nLog types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A list of log types that this DB instance is configured to export to CloudWatch Logs.
\nLog types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n
" } }, "ProcessorFeatures": { @@ -8455,7 +8461,7 @@ "CustomerOwnedIpEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "AwsBackupRecoveryPointArn": { @@ -8509,7 +8515,7 @@ "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
" } }, "BackupTarget": { @@ -8521,7 +8527,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
" } }, "ActivityStreamPolicyStatus": { @@ -8533,7 +8539,7 @@ "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the storage throughput for the DB instance.
\nThis setting applies only to the gp3 storage type.
Specifies the storage throughput for the DB instance.
\nThis setting applies only to the gp3 storage type.
Contains the details of an Amazon RDS DB instance.
\nThis data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.
Contains the details of an Amazon RDS DB instance.
\nThis data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.
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\n for the first automated snapshot to be available.
The port number that the automated backup used for connections.
\nDefault: Inherits from the source DB instance
\nValid Values: 1150-65535\n
The port number that the automated backup used for connections.
\nDefault: Inherits from the source DB instance
\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.
" + "smithy.api#documentation": "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.
" } }, "Timezone": { @@ -8894,7 +8900,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:
\n\n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.
\n PENDING - the IAM role ARN is being associated with the DB instance.
\n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:
\n\n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.
\n PENDING - the IAM role ARN is being associated with the DB instance.
\n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.
Contains the details of an Amazon RDS DB parameter group.
\nThis data type is used as a response element in the DescribeDBParameterGroups action.
Contains the details of an Amazon RDS DB parameter group.
\nThis data type is used as a response element in the DescribeDBParameterGroups action.
The status of the DB parameter group.
\nThis data type is used as a response element in the following actions:
\n\n CreateDBInstance\n
\n CreateDBInstanceReadReplica\n
\n DeleteDBInstance\n
\n ModifyDBInstance\n
\n RebootDBInstance\n
\n RestoreDBInstanceFromDBSnapshot\n
The status of the DB parameter group.
\nThis data type is used as a response element in the following actions:
\n\n CreateDBInstance\n
\n CreateDBInstanceReadReplica\n
\n DeleteDBInstance\n
\n ModifyDBInstance\n
\n RebootDBInstance\n
\n RestoreDBInstanceFromDBSnapshot\n
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.
\nDefault: 1800 (30 minutes)
\nConstraints: 1 to 28,800
" + "smithy.api#documentation": "The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.
\nDefault: 1800 (30 minutes)
\nConstraints: 1 to 28,800
" } }, "DebugLogging": { @@ -9294,7 +9300,7 @@ } }, "traits": { - "smithy.api#documentation": "The data structure representing a proxy managed by the RDS Proxy.
\nThis data type is used as a response element in the DescribeDBProxies action.
The data structure representing a proxy managed by the RDS Proxy.
\nThis data type is used as a response element in the DescribeDBProxies action.
The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.
\nThis data type is used as a response element in the DescribeDBProxyEndpoints operation.
The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.
\nThis data type is used as a response element in the DescribeDBProxyEndpoints operation.
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
\nThis data type is used as a response element in the DescribeDBProxyTargets action.
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
\nThis data type is used as a response element in the DescribeDBProxyTargets action.
Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.
\nThis data type is used as a response element in the DescribeDBProxyTargetGroups action.
Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.
\nThis data type is used as a response element in the DescribeDBProxyTargetGroups action.
Contains the details for an Amazon RDS DB security group.
\nThis data type is used as a response element \n in the DescribeDBSecurityGroups action.
Contains the details for an Amazon RDS DB security group.
\nThis data type is used as a response element \n in the DescribeDBSecurityGroups action.
This data type is used as a response element in the following actions:
\n\n ModifyDBInstance\n
\n RebootDBInstance\n
\n RestoreDBInstanceFromDBSnapshot\n
\n RestoreDBInstanceToPointInTime\n
This data type is used as a response element in the following actions:
\n\n ModifyDBInstance\n
\n RebootDBInstance\n
\n RestoreDBInstanceFromDBSnapshot\n
\n RestoreDBInstanceToPointInTime\n
If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" + "smithy.api#documentation": "If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "DBSnapshotArn": { @@ -10161,7 +10167,7 @@ "SnapshotDatabaseTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
\nIf you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.
" + "smithy.api#documentation": "The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
\nIf you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.
" } }, "SnapshotTarget": { @@ -10178,7 +10184,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the details of an Amazon RDS DB snapshot.
\nThis data type is used as a response element \n in the DescribeDBSnapshots action.
Contains the details of an Amazon RDS DB snapshot.
\nThis data type is used as a response element \n in the DescribeDBSnapshots action.
The name of the manual DB snapshot attribute.
\nThe attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.
The name of the manual DB snapshot attribute.
\nThe attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.
The value or values for the manual DB snapshot attribute.
\nIf the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.
The value or values for the manual DB snapshot attribute.
\nIf the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.
Contains the name and values of a manual DB snapshot attribute
\nManual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.
Contains the name and values of a manual DB snapshot attribute
\nManual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.
Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.
Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.
The network type of the DB subnet group.
\nValid values:
\n\n IPV4\n
\n DUAL\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 RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB subnet group.
\nValid values:
\n\n IPV4\n
\n DUAL\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 RDS User Guide.\n
" } } }, "traits": { - "smithy.api#documentation": "Contains the details of an Amazon RDS DB subnet group.
\nThis data type is used as a response element \n in the DescribeDBSubnetGroups action.
Contains the details of an Amazon RDS DB subnet group.
\nThis data type is used as a response element \n in the DescribeDBSubnetGroups action.
Deletes a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "Deletes a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" } }, "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest": { @@ -10527,7 +10533,7 @@ "BlueGreenDeploymentIdentifier": { "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", "traits": { - "smithy.api#documentation": "The blue/green deployment identifier of the deployment to be deleted. This parameter isn't case-sensitive.
\nConstraints:\n
\nMust match an existing blue/green deployment identifier.
\nThe blue/green deployment identifier of the deployment to be deleted. This parameter isn't case-sensitive.
\nConstraints:\n
\nMust match an existing blue/green deployment identifier.
\nDeletes a custom engine version. To run this command, make sure you meet the following prerequisites:
\nThe CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.
\nThe CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.
\nTypically, deletion takes a few minutes.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.
For more information, see \n Deleting a CEV in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
\nThe CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.
\nThe CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.
\nTypically, deletion takes a few minutes.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.
For more information, see \n Deleting a CEV in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage": { @@ -10612,7 +10618,7 @@ } ], "traits": { - "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.
\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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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.
\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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#DeleteDBClusterEndpoint": { @@ -10635,7 +10641,7 @@ } ], "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 identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
\nConstraints:
\nMust match an existing DBClusterIdentifier.
\nThe DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
\nConstraints:
\nMust match an existing DBClusterIdentifier.
\nA value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.
\nYou must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.
\nYou must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
The 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
\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
\nDeletes 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { @@ -10704,7 +10710,7 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster parameter group.
\nConstraints:
\nMust be the name of an existing DB cluster parameter group.
\nYou can't delete a default DB cluster parameter group.
\nCan't be associated with any DB clusters.
\nThe name of the DB cluster parameter group.
\nConstraints:
\nMust be the name of an existing DB cluster parameter group.
\nYou can't delete a default DB cluster parameter group.
\nCan't be associated with any DB clusters.
\nDeletes 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { @@ -10747,7 +10753,7 @@ "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the DB cluster snapshot to delete.
\nConstraints: Must be the name of an existing DB cluster snapshot in the available state.
The identifier of the DB cluster snapshot to delete.
\nConstraints: Must be the name of an existing DB cluster snapshot in the available state.
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.
The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" } } }, @@ -10850,7 +10856,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the name of an existing DB instance.
\nThe DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the name of an existing DB instance.
\nA value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.
\nIf you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
\nThis setting is required for RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.
\nIf you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
\nThis setting is required for RDS Custom.
" } }, "FinalDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters or numbers.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nCan't be specified when deleting a read replica.
\nThe DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters or numbers.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nCan't be specified when deleting a read replica.
\nThe name of the DB parameter group.
\nConstraints:
\nMust be the name of an existing DB parameter group
\nYou can't delete a default DB parameter group
\nCan't be associated with any DB instances
\nThe name of the DB parameter group.
\nConstraints:
\nMust be the name of an existing DB parameter group
\nYou can't delete a default DB parameter group
\nCan't be associated with any DB instances
\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 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.
\nThe name of the DB security group to delete.
\nYou can't delete the default DB security group.
\nConstraints:
\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
\nMust not be \"Default\"
\nThe name of the DB security group to delete.
\nYou can't delete the default DB security group.
\nConstraints:
\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
\nMust not be \"Default\"
\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.
The DB snapshot identifier.
\nConstraints: Must be the name of an existing DB snapshot in the available state.
The DB snapshot identifier.
\nConstraints: Must be the name of an existing DB snapshot in the available state.
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.
\nThe name of the database subnet group to delete.
\nYou can't delete the default subnet group.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
The name of the database subnet group to delete.
\nYou can't delete the default subnet group.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
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.
\nThe name of the option group to be deleted.
\nYou can't delete default option groups.
\nThe name of the option group to be deleted.
\nYou can't delete default option groups.
\nLists 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.
" } }, "com.amazonaws.rds#DescribeAccountAttributesMessage": { @@ -11334,7 +11340,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about blue/green deployments.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
", + "smithy.api#documentation": "Returns information about blue/green deployments.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11349,13 +11355,13 @@ "BlueGreenDeploymentIdentifier": { "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", "traits": { - "smithy.api#documentation": "The blue/green deployment identifier. If this parameter is specified, information from only the \n specific blue/green deployment is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing blue/green deployment identifier.
\nThe blue/green deployment identifier. If this parameter is specified, information from only the \n specific blue/green deployment is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing blue/green deployment identifier.
\nA filter that specifies one or more blue/green deployments to describe.
\nSupported filters:
\n\n blue-green-deployment-identifier - Accepts system-generated\n identifiers for blue/green deployments. The results list only includes\n information about the blue/green deployments with the specified\n identifiers.
\n blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. \n The results list only includes information about the blue/green deployments with the \n specified names.
\n source - Accepts source databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified source databases.
\n target - Accepts target databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified target databases.
A filter that specifies one or more blue/green deployments to describe.
\nSupported filters:
\n\n blue-green-deployment-identifier - Accepts system-generated\n identifiers for blue/green deployments. The results list only includes\n information about the blue/green deployments with the specified\n identifiers.
\n blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. \n The results list only includes information about the blue/green deployments with the \n specified names.
\n source - Accepts source databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified source databases.
\n target - Accepts target databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified target databases.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } @@ -11418,7 +11424,7 @@ "CertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.
\nConstraints:
\nMust match an existing CertificateIdentifier.
\nThe user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.
\nConstraints:
\nMust match an existing CertificateIdentifier.
\nThe maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -11461,7 +11467,7 @@ } ], "traits": { - "smithy.api#documentation": "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 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.
\nThe DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
The DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
If specified, this value is the backtrack identifier of the backtrack to be\n described.
\nConstraints:
\nMust contain a valid universally unique identifier (UUID). For more\n information about UUIDs, see A Universally Unique Identifier \n (UUID) URN Namespace.
\nExample: 123e4567-e89b-12d3-a456-426655440000\n
If specified, this value is the backtrack identifier of the backtrack to be\n described.
\nConstraints:
\nMust contain a valid universally unique identifier (UUID). For more\n information about UUIDs, see A Universally Unique Identifier \n (UUID) URN Namespace.
\nExample: 123e4567-e89b-12d3-a456-426655440000\n
A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:
\n\n db-cluster-backtrack-id - Accepts backtrack identifiers. The\n results list includes information about only the backtracks identified by these\n identifiers.
\n db-cluster-backtrack-status - Accepts any of the following backtrack status values:
\n applying\n
\n completed\n
\n failed\n
\n pending\n
The results list includes information about only the backtracks identified\n by these values.
\nA filter that specifies one or more DB clusters to describe. Supported filters\n include the following:
\n\n db-cluster-backtrack-id - Accepts backtrack identifiers. The\n results list includes information about only the backtracks identified by these\n identifiers.
\n db-cluster-backtrack-status - Accepts any of the following backtrack status values:
\n applying\n
\n completed\n
\n failed\n
\n pending\n
The results list includes information about only the backtracks identified\n by these values.
\nThe maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -11523,7 +11529,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about endpoints for an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nReturns information about endpoints for an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nThe maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -11581,7 +11587,7 @@ } ], "traits": { - "smithy.api#documentation": "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", + "smithy.api#documentation": "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11596,7 +11602,7 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of a specific DB cluster parameter group to return details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nThe name of a specific DB cluster parameter group to return details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nThe maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -11636,7 +11642,7 @@ } ], "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", + "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11651,7 +11657,7 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of a specific DB cluster parameter group to return parameter details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nThe name of a specific DB cluster parameter group to return parameter details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nThe maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -11698,7 +11704,7 @@ } ], "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", + "smithy.api#documentation": "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11881,31 +11887,31 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.
Constraints:
\nIf supplied, must match the identifier of an existing DBCluster.
\nThe ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.
Constraints:
\nIf supplied, must match the identifier of an existing DBCluster.
\nA specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.
Constraints:
\nIf supplied, must match the identifier of an existing DBClusterSnapshot.
\nIf this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.
Constraints:
\nIf supplied, must match the identifier of an existing DBClusterSnapshot.
\nIf this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of DB cluster snapshots to be returned. You can specify one of the following values:
\n\n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.
\n manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
\n shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
\n public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.
The type of DB cluster snapshots to be returned. You can specify one of the following values:
\n\n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.
\n manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
\n shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
\n public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.
A filter that specifies one or more DB cluster snapshots to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs).
\n db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
\n snapshot-type - Accepts types of DB cluster snapshots.
\n engine - Accepts names of database engines.
A filter that specifies one or more DB cluster snapshots to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs).
\n db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
\n snapshot-type - Accepts types of DB cluster snapshots.
\n engine - Accepts names of database engines.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -11918,14 +11924,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
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.
" + "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.
" } } }, @@ -11947,7 +11953,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
", + "smithy.api#documentation": "Returns information about 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12090,19 +12096,19 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing DBClusterIdentifier.
\nThe user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing DBClusterIdentifier.
\nA filter that specifies one or more DB clusters to describe.
\nSupported filters:
\n\n clone-group-id - Accepts clone group identifiers. \n The results list only includes information about\n the DB clusters associated with these clone groups.
\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about\n the DB clusters identified by these ARNs.
\n domain - Accepts Active Directory directory IDs. \n The results list only includes information about\n the DB clusters associated with these domains.
\n engine - Accepts engine names. \n The results list only includes information about\n the DB clusters for these engines.
A filter that specifies one or more DB clusters to describe.
\nSupported filters:
\n\n clone-group-id - Accepts clone group identifiers. \n The results list only includes information about\n the DB clusters associated with these clone groups.
\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about\n the DB clusters identified by these ARNs.
\n domain - Accepts Active Directory directory IDs. \n The results list only includes information about\n the DB clusters associated with these domains.
\n engine - Accepts engine names. \n The results list only includes information about\n the DB clusters for these engines.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -12147,31 +12153,31 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database engine to return.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to return.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine version to return.
\nExample: 5.1.49\n
The database engine version to return.
\nExample: 5.1.49\n
The name of a specific DB parameter group family to return details for.
\nConstraints:
\nIf supplied, must match an existing DBParameterGroupFamily.
\nThe name of a specific DB parameter group family to return details for.
\nConstraints:
\nIf supplied, must match an existing DBParameterGroupFamily.
\nA filter that specifies one or more DB engine versions to describe.
\nSupported filters:
\n\n db-parameter-group-family - Accepts parameter groups family names. \n The results list only includes information about\n the DB engine versions for these parameter group families.
\n engine - Accepts engine names. \n The results list only includes information about\n the DB engine versions for these engines.
\n engine-mode - Accepts DB engine modes. \n The results list only includes information about\n the DB engine versions for these engine modes. Valid \n DB engine modes are the following:
\n global\n
\n multimaster\n
\n parallelquery\n
\n provisioned\n
\n serverless\n
\n engine-version - Accepts engine versions. \n The results list only includes information about\n the DB engine versions for these engine versions.
\n status - Accepts engine version statuses. \n The results list only includes information about\n the DB engine versions for these statuses. Valid statuses \n are the following:
\n available\n
\n deprecated\n
A filter that specifies one or more DB engine versions to describe.
\nSupported filters:
\n\n db-parameter-group-family - Accepts parameter groups family names. \n The results list only includes information about\n the DB engine versions for these parameter group families.
\n engine - Accepts engine names. \n The results list only includes information about\n the DB engine versions for these engines.
\n engine-mode - Accepts DB engine modes. \n The results list only includes information about\n the DB engine versions for these engine modes. Valid \n DB engine modes are the following:
\n global\n
\n multimaster\n
\n parallelquery\n
\n provisioned\n
\n serverless\n
\n engine-version - Accepts engine versions. \n The results list only includes information about\n the DB engine versions for these engine versions.
\n status - Accepts engine version statuses. \n The results list only includes information about\n the DB engine versions for these statuses. Valid statuses \n are the following:
\n available\n
\n deprecated\n
The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -12190,13 +12196,13 @@ "ListSupportedCharacterSets": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to list the supported character sets for each engine version.
\nIf this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.
For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.
A value that indicates whether to list the supported character sets for each engine version.
\nIf this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.
For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.
A value that indicates whether to list the supported time zones for each engine version.
\nIf this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.
A value that indicates whether to list the supported time zones for each engine version.
\nIf this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.
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#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#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12248,7 +12254,7 @@ "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 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.
" } }, "MaxRecords": { @@ -12266,7 +12272,7 @@ "DBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" } } }, @@ -12288,7 +12294,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about provisioned RDS instances. This API supports pagination.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
\nReturns information about provisioned RDS instances. This API supports pagination.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
\nThe user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBInstance.
\nThe user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBInstance.
\nA filter that specifies one or more DB instances to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about \n the DB instances associated with the DB clusters identified by these ARNs.
\n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list only includes information about\n the DB instances identified by these ARNs.
\n dbi-resource-id - Accepts DB instance resource identifiers. The results list will \n only include information about the DB instances identified by these DB instance resource identifiers.
\n domain - Accepts Active Directory directory IDs. The results list only includes \n information about the DB instances associated with these domains.
\n engine - Accepts engine names. The results list only includes information \n about the DB instances for these engines.
A filter that specifies one or more DB instances to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about \n the DB instances associated with the DB clusters identified by these ARNs.
\n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list only includes information about\n the DB instances identified by these ARNs.
\n dbi-resource-id - Accepts DB instance resource identifiers. The results list will \n only include information about the DB instances identified by these DB instance resource identifiers.
\n domain - Accepts Active Directory directory IDs. The results list only includes \n information about the DB instances associated with these domains.
\n engine - Accepts engine names. The results list only includes information \n about the DB instances for these engines.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -12474,7 +12480,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of DB log files for the DB instance.
\nThis command doesn't apply to RDS Custom.
", + "smithy.api#documentation": "Returns a list of DB log files for the DB instance.
\nThis command doesn't apply to RDS Custom.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12526,7 +12532,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The customer-assigned name of the DB instance that contains the log files you want to list.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe customer-assigned name of the DB instance that contains the log files you want to list.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe name of a specific DB parameter group to return details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nThe name of a specific DB parameter group to return details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nThe maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -12677,14 +12683,14 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of a specific DB parameter group to return details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nThe name of a specific DB parameter group to return details for.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nThe parameter types to return.
\nDefault: All parameter types returned
\nValid Values: user | system | engine-default\n
The parameter types to return.
\nDefault: All parameter types returned
\nValid Values: user | system | engine-default\n
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -12754,7 +12760,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } @@ -12832,7 +12838,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } @@ -12914,7 +12920,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } @@ -12999,7 +13005,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } } @@ -13035,7 +13041,7 @@ } ], "traits": { - "smithy.api#documentation": "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 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.
\nThe maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -13090,7 +13096,7 @@ } ], "traits": { - "smithy.api#documentation": "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 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.
The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBInstance.
\nThe ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBInstance.
\nA specific DB snapshot identifier to describe.\n This value is stored as a lowercase string.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBSnapshot.
\nIf this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
A specific DB snapshot identifier to describe.\n This value is stored as a lowercase string.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBSnapshot.
\nIf this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of snapshots to be returned. You can specify one of the following values:
\n\n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.
\n manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
\n shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
\n public - Return all DB snapshots that have been marked as public.
\n awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the \n \n Amazon Web Services Backup Developer Guide.\n \n
\nThe awsbackup type does not apply to Aurora.
If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.
The type of snapshots to be returned. You can specify one of the following values:
\n\n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.
\n manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
\n shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
\n public - Return all DB snapshots that have been marked as public.
\n awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the \n \n Amazon Web Services Backup Developer Guide.\n \n
\nThe awsbackup type does not apply to Aurora.
If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.
A filter that specifies one or more DB snapshots to describe.
\nSupported filters:
\n\n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).
\n db-snapshot-id - Accepts DB snapshot identifiers.
\n dbi-resource-id - Accepts identifiers of source DB instances.
\n snapshot-type - Accepts types of DB snapshots.
\n engine - Accepts names of database engines.
A filter that specifies one or more DB snapshots to describe.
\nSupported filters:
\n\n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).
\n db-snapshot-id - Accepts DB snapshot identifiers.
\n dbi-resource-id - Accepts identifiers of source DB instances.
\n snapshot-type - Accepts types of DB snapshots.
\n engine - Accepts names of database engines.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -13313,14 +13319,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { "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 snapshot as public by using the ModifyDBSnapshotAttribute API.
\nThis setting doesn't apply to RDS Custom.
" + "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 snapshot as public by using the ModifyDBSnapshotAttribute API.
\nThis setting doesn't apply to RDS Custom.
" } }, "DbiResourceId": { @@ -13348,7 +13354,7 @@ } ], "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#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#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13375,7 +13381,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -13398,7 +13404,7 @@ "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.
" } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { @@ -13420,7 +13426,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -13466,7 +13472,7 @@ "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group family.
\nValid Values:
\n\n aurora5.6\n
\n aurora-mysql5.7\n
\n aurora-mysql8.0\n
\n aurora-postgresql10\n
\n aurora-postgresql11\n
\n aurora-postgresql12\n
\n aurora-postgresql13\n
\n aurora-postgresql14\n
\n custom-oracle-ee-19\n
\n mariadb10.2\n
\n mariadb10.3\n
\n mariadb10.4\n
\n mariadb10.5\n
\n mariadb10.6\n
\n mysql5.7\n
\n mysql8.0\n
\n oracle-ee-19\n
\n oracle-ee-cdb-19\n
\n oracle-ee-cdb-21\n
\n oracle-se2-19\n
\n oracle-se2-cdb-19\n
\n oracle-se2-cdb-21\n
\n postgres10\n
\n postgres11\n
\n postgres12\n
\n postgres13\n
\n postgres14\n
\n sqlserver-ee-11.0\n
\n sqlserver-ee-12.0\n
\n sqlserver-ee-13.0\n
\n sqlserver-ee-14.0\n
\n sqlserver-ee-15.0\n
\n sqlserver-ex-11.0\n
\n sqlserver-ex-12.0\n
\n sqlserver-ex-13.0\n
\n sqlserver-ex-14.0\n
\n sqlserver-ex-15.0\n
\n sqlserver-se-11.0\n
\n sqlserver-se-12.0\n
\n sqlserver-se-13.0\n
\n sqlserver-se-14.0\n
\n sqlserver-se-15.0\n
\n sqlserver-web-11.0\n
\n sqlserver-web-12.0\n
\n sqlserver-web-13.0\n
\n sqlserver-web-14.0\n
\n sqlserver-web-15.0\n
The name of the DB parameter group family.
\nValid Values:
\n\n aurora5.6\n
\n aurora-mysql5.7\n
\n aurora-mysql8.0\n
\n aurora-postgresql10\n
\n aurora-postgresql11\n
\n aurora-postgresql12\n
\n aurora-postgresql13\n
\n aurora-postgresql14\n
\n custom-oracle-ee-19\n
\n mariadb10.2\n
\n mariadb10.3\n
\n mariadb10.4\n
\n mariadb10.5\n
\n mariadb10.6\n
\n mysql5.7\n
\n mysql8.0\n
\n oracle-ee-19\n
\n oracle-ee-cdb-19\n
\n oracle-ee-cdb-21\n
\n oracle-se2-19\n
\n oracle-se2-cdb-19\n
\n oracle-se2-cdb-21\n
\n postgres10\n
\n postgres11\n
\n postgres12\n
\n postgres13\n
\n postgres14\n
\n sqlserver-ee-11.0\n
\n sqlserver-ee-12.0\n
\n sqlserver-ee-13.0\n
\n sqlserver-ee-14.0\n
\n sqlserver-ee-15.0\n
\n sqlserver-ex-11.0\n
\n sqlserver-ex-12.0\n
\n sqlserver-ex-13.0\n
\n sqlserver-ex-14.0\n
\n sqlserver-ex-15.0\n
\n sqlserver-se-11.0\n
\n sqlserver-se-12.0\n
\n sqlserver-se-13.0\n
\n sqlserver-se-14.0\n
\n sqlserver-se-15.0\n
\n sqlserver-web-11.0\n
\n sqlserver-web-12.0\n
\n sqlserver-web-13.0\n
\n sqlserver-web-14.0\n
\n sqlserver-web-15.0\n
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -13510,7 +13516,7 @@ "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 .
" } }, "com.amazonaws.rds#DescribeEventCategoriesMessage": { @@ -13519,7 +13525,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
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.
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.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -13597,7 +13603,7 @@ "target": "com.amazonaws.rds#EventsMessage" }, "traits": { - "smithy.api#documentation": "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 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.
\nThe identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
\nConstraints:
\nIf SourceIdentifier is supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
Can't end with a hyphen or contain two consecutive hyphens.
\nThe identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
\nConstraints:
\nIf SourceIdentifier is supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
Can't end with a hyphen or contain two consecutive hyphens.
\nThe beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n
\nExample: 2009-07-08T18:00Z
" + "smithy.api#documentation": "The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n
\nExample: 2009-07-08T18:00Z
" } }, "EndTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n
\nExample: 2009-07-08T18:00Z
" + "smithy.api#documentation": "The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n
\nExample: 2009-07-08T18:00Z
" } }, "Duration": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of minutes to retrieve events for.
\nDefault: 60
" + "smithy.api#documentation": "The number of minutes to retrieve events for.
\nDefault: 60
" } }, "EventCategories": { @@ -13654,7 +13660,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -13709,7 +13715,7 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.
\nSupported filters include the following:
\n\n export-task-identifier - An identifier for the snapshot export task.
\n s3-bucket - The Amazon S3 bucket the snapshot is exported to.
\n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
\n status - The status of the export task. Must be lowercase. Valid statuses are the following:
\n canceled\n
\n canceling\n
\n complete\n
\n failed\n
\n in_progress\n
\n starting\n
Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.
\nSupported filters include the following:
\n\n export-task-identifier - An identifier for the snapshot export task.
\n s3-bucket - The Amazon S3 bucket the snapshot is exported to.
\n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
\n status - The status of the export task. Must be lowercase. Valid statuses are the following:
\n canceled\n
\n canceling\n
\n complete\n
\n failed\n
\n in_progress\n
\n starting\n
The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "SourceType": { @@ -13746,7 +13752,7 @@ } ], "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.
\nReturns 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.
\nThe user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing DBClusterIdentifier.
\nThe user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing DBClusterIdentifier.
\nThe 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 you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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 you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -13808,7 +13814,7 @@ "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A required parameter. Options available for the given engine name are described.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
A required parameter. Options available for the given engine name are described.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -13888,13 +13894,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Filters the list of option groups to only include groups associated with a specific database engine.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Filters the list of option groups to only include groups associated with a specific database engine.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the engine to retrieve DB instance options for.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the engine to retrieve DB instance options for.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.
\nRDS Custom supports only the BYOL licensing model.
" + "smithy.api#documentation": "The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.
\nRDS Custom supports only the BYOL licensing model.
" } }, "AvailabilityZoneGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
\nOmit this parameter to show the available offerings in the specified Amazon Web Services Region.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
\nOmit this parameter to show the available offerings in the specified Amazon Web Services Region.
\nThis setting doesn't apply to RDS Custom.
" } }, "Vpc": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.
\nRDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.
" + "smithy.api#documentation": "A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.
\nRDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.
" } }, "Filters": { @@ -13975,7 +13981,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 10000.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 10000.
" } }, "Marker": { @@ -14024,7 +14030,7 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "A filter that specifies one or more resources to return pending maintenance actions for.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance \n actions for the DB clusters identified by these ARNs.
\n db-instance-id - Accepts DB instance identifiers and DB \n instance ARNs. The results list only includes pending maintenance \n actions for the DB instances identified by these ARNs.
A filter that specifies one or more resources to return pending maintenance actions for.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance \n actions for the DB clusters identified by these ARNs.
\n db-instance-id - Accepts DB instance identifiers and DB \n instance ARNs. The results list only includes pending maintenance \n actions for the DB instances identified by these ARNs.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } }, @@ -14091,7 +14097,7 @@ "Duration": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
\nValid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
\nValid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
\nAmazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
\nThe lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
\nAmazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
\nThe maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -14170,7 +14176,7 @@ "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
\nThe results show offerings that partially match the filter value.
\nProduct description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
\nThe results show offerings that partially match the filter value.
\nThe offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
\nValid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
\nValid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n
The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -14235,7 +14241,7 @@ "target": "com.amazonaws.rds#SourceRegionMessage" }, "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.
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.
The source Amazon Web Services Region name. For example, us-east-1.
Constraints:
\nMust specify a valid Amazon Web Services Region name.
\nThe source Amazon Web Services Region name. For example, us-east-1.
Constraints:
\nMust specify a valid Amazon Web Services Region name.
\nThe maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -14293,7 +14299,7 @@ } ], "traits": { - "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#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.
" } }, "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { @@ -14444,7 +14450,7 @@ } ], "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#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#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -14485,7 +14491,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The customer-assigned name of the DB instance that contains the log files you want to list.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe customer-assigned name of the DB instance that contains the log files you want to list.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
\nIf the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.
\nIf neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.
\nIf \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.
\nIf Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.
\nYou can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.
\nThe number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
\nIf the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.
\nIf neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.
\nIf \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.
\nIf Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.
\nYou can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.
\nThis data type is used as a response element in the following actions:
\n\n AuthorizeDBSecurityGroupIngress\n
\n DescribeDBSecurityGroups\n
\n RevokeDBSecurityGroupIngress\n
This data type is used as a response element in the following actions:
\n\n AuthorizeDBSecurityGroupIngress\n
\n DescribeDBSecurityGroups\n
\n RevokeDBSecurityGroupIngress\n
This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:
\n\n CreateDBInstance\n
\n DescribeDBInstances\n
\n DeleteDBInstance\n
For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.
This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:
\n\n CreateDBInstance\n
\n DescribeDBInstances\n
\n DeleteDBInstance\n
For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.
The status of the RDS event notification subscription.
\nConstraints:
\nCan be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
\nThe status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
" + "smithy.api#documentation": "The status of the RDS event notification subscription.
\nConstraints:
\nCan be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
\nThe status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
" } }, "SubscriptionCreationTime": { @@ -14915,7 +14921,7 @@ "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "The data exported from the snapshot. 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. 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. \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.
The data exported from the snapshot. 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. 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. \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.
Contains the details of a snapshot export to Amazon S3.
\nThis data type is used as a response element in the DescribeExportTasks action.
Contains the details of a snapshot export to Amazon S3.
\nThis data type is used as a response element in the DescribeExportTasks action.
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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#FailoverDBClusterMessage": { @@ -15092,14 +15098,14 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nA DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nThe name of the DB instance to promote to the primary DB instance.
\nSpecify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
" + "smithy.api#documentation": "The name of the DB instance to promote to the primary DB instance.
\nSpecify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
" } } }, @@ -15138,7 +15144,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates the failover process for an Aurora global database (GlobalCluster).
\nA failover for an Aurora global database promotes one of secondary read-only DB clusters to be\n the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words,\n the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected\n secondary DB cluster assumes full read/write capabilities for the Aurora global database.
\nFor more information about failing over an Amazon Aurora global database, see\n Managed planned failover for Amazon Aurora global\n databases in the Amazon Aurora User Guide.
\nThis action applies to GlobalCluster (Aurora global databases) only. Use this action only on\n healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to\n reconfigure your Aurora global database topology.
\nInitiates the failover process for an Aurora global database (GlobalCluster).
\nA failover for an Aurora global database promotes one of secondary read-only DB clusters to be\n the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words,\n the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected\n secondary DB cluster assumes full read/write capabilities for the Aurora global database.
\nFor more information about failing over an Amazon Aurora global database, see\n Managed planned failover for Amazon Aurora global\n databases in the Amazon Aurora User Guide.
\nThis action applies to GlobalCluster (Aurora global databases) only. Use this action only on\n healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to\n reconfigure your Aurora global database topology.
\nIdentifier of the Aurora global database (GlobalCluster)\n that should be failed over. The identifier is the unique key assigned by\n the user when the Aurora global database was created. In other words,\n it's the name of the Aurora global database that you want to fail over.
\nConstraints:
\nMust match the identifier of an existing\n GlobalCluster (Aurora global database).
\nIdentifier of the Aurora global database (GlobalCluster)\n that should be failed over. The identifier is the unique key assigned by\n the user when the Aurora global database was created. In other words,\n it's the name of the Aurora global database that you want to fail over.
\nConstraints:
\nMust match the identifier of an existing\n GlobalCluster (Aurora global database).
\nThe current status of the Aurora global database (GlobalCluster). Possible values are as follows:
\npending A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The\n GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover\n process can start.
failing-over This status covers the range of Aurora internal operations that take place during the failover process, such\n as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
\ncancelling The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary\n Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
\nThe current status of the Aurora global database (GlobalCluster). Possible values are as follows:
\npending A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The\n GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover\n process can start.
failing-over This status covers the range of Aurora internal operations that take place during the failover process, such\n as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
\ncancelling The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary\n Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
\nA filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.
\nCurrently, wildcards are not supported in filters.
\nThe following actions can be filtered:
\n\n DescribeDBClusterBacktracks\n
\n DescribeDBClusterEndpoints\n
\n DescribeDBClusters\n
\n DescribeDBInstances\n
\n DescribePendingMaintenanceActions\n
A filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.
\nCurrently, wildcards are not supported in filters.
\nThe following actions can be filtered:
\n\n DescribeDBClusterBacktracks\n
\n DescribeDBClusterEndpoints\n
\n DescribeDBClusters\n
\n DescribeDBInstances\n
\n DescribePendingMaintenanceActions\n
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.
" } }, "com.amazonaws.rds#ListTagsForResourceMessage": { @@ -16247,7 +16253,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.
\nThis operation is supported for RDS for Oracle only.
" + "smithy.api#documentation": "Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.
\nThis operation is supported for RDS for Oracle only.
" } }, "com.amazonaws.rds#ModifyActivityStreamRequest": { @@ -16322,7 +16328,7 @@ } ], "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.
" } }, "com.amazonaws.rds#ModifyCertificatesMessage": { @@ -16331,7 +16337,7 @@ "CertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new default certificate identifier to override the current one with.
\nTo determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.
The new default certificate identifier to override the current one with.
\nTo determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.
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 DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DB cluster.
\nThe DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DB cluster.
\nThe DB cluster capacity.
\nWhen you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
\nConstraints:
\nFor Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The DB cluster capacity.
\nWhen you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
\nConstraints:
\nFor Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.
\nSpecify a value between 10 and 600 seconds.
" + "smithy.api#documentation": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.
\nSpecify a value between 10 and 600 seconds.
" } }, "TimeoutAction": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The 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 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.
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status \n in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage": { @@ -16449,7 +16455,7 @@ "Status": { "target": "com.amazonaws.rds#CustomEngineVersionStatus", "traits": { - "smithy.api#documentation": "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.
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.
Modify the settings for 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Modify the settings for 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#ModifyDBClusterEndpoint": { @@ -16530,7 +16536,7 @@ } ], "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.
\nThe DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nConstraints: This identifier must match the identifier of an existing DB\n cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nConstraints: This identifier must match the identifier of an existing DB\n cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "NewDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
Valid for: Aurora DB clusters only
" } }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.
By default, this parameter is disabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.
By default, this parameter is disabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which automated backups are retained. Specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The number of days for which automated backups are retained. Specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster parameter group to use for the DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the DB cluster parameter group to use for the DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of VPC security groups that the DB cluster will belong to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A list of VPC security groups that the DB cluster will belong to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the DB cluster accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB cluster.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The port number on which the DB cluster accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB cluster.
\nValid for: Aurora DB clusters only
" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group.
\nDB clusters are associated with a default option group that can't be modified.
" + "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" + "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" } }, "CloudwatchLogsExportConfiguration": { "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", "traits": { - "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
Valid for: Aurora DB clusters only
" } }, "DBInstanceParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to apply to all instances of the DB cluster.
\nWhen you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.
Default: The existing name setting
\nConstraints:
\nThe DB parameter group must be in the same DB parameter group family as this DB cluster.
\nThe DBInstanceParameterGroupName parameter is valid in combination with the\n AllowMajorVersionUpgrade parameter for a major version upgrade only.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "The name of the DB parameter group to apply to all instances of the DB cluster.
\nWhen you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.
Default: The existing name setting
\nConstraints:
\nThe DB parameter group must be in the same DB parameter group family as this DB cluster.
\nThe DBInstanceParameterGroupName parameter is valid in combination with the\n AllowMajorVersionUpgrade parameter for a major version upgrade only.
Valid for: Aurora DB clusters only
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.
For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.
For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for: Aurora DB clusters only
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
\nValid for: Aurora DB clusters only
" } }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nType: Integer
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nType: Integer
\nValid for: Multi-AZ DB clusters only
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nValid values: io1\n
When specified, a value for the Iops parameter is required.
Default: io1\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nValid values: io1\n
When specified, a value for the Iops parameter is required.
Default: io1\n
Valid for: Multi-AZ DB clusters only
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nValid for: Multi-AZ DB clusters only
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for: Multi-AZ DB clusters only
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nValid for: Multi-AZ DB clusters only
" } }, "ServerlessV2ScalingConfiguration": { @@ -16779,7 +16785,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "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
" + "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
" } } }, @@ -16804,7 +16810,7 @@ } ], "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { @@ -16820,7 +16826,7 @@ "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { - "smithy.api#documentation": "A list of parameters in the DB cluster parameter group to modify.
\nValid Values (for the application method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB clusters associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the \n parameter group.
A list of parameters in the DB cluster parameter group to modify.
\nValid Values (for the application method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB clusters associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the \n parameter group.
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.
The name of the DB cluster snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.
\nThe name of the DB cluster snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.
\nA list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.
The DB instance identifier. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe DB instance identifier. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe new amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nFor MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.
\nFor the valid values for allocated storage for each engine,\n see CreateDBInstance.
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nFor MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.
\nFor the valid values for allocated storage for each engine,\n see CreateDBInstance.
The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and \n availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.
\nIf you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.
This setting doesn't apply to RDS Custom for Oracle.
\nDefault: Uses existing setting
" + "smithy.api#documentation": "The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and \n availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.
\nIf you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.
This setting doesn't apply to RDS Custom for Oracle.
\nDefault: Uses existing setting
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.
\nChanging the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.
This parameter doesn't apply to RDS Custom.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.
\nChanging the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.
This parameter doesn't apply to RDS Custom.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match existing DBSecurityGroups.
\nA list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match existing DBSecurityGroups.
\nA list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nIf supplied, must match existing VpcSecurityGroupIds.
\nA list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nIf supplied, must match existing VpcSecurityGroupIds.
\nA value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.
A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.
The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".
\nChanging this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.
Default: Uses existing setting
\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
\nAmazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.
\nThe new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".
\nChanging this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.
Default: Uses existing setting
\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
\nAmazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.
\nThe name of the DB parameter group to apply to the DB instance.
\nChanging this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Uses existing setting
\nConstraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
" + "smithy.api#documentation": "The name of the DB parameter group to apply to the DB instance.
\nChanging this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Uses existing setting
\nConstraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
\nThese changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.
\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nIt must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
\nIt can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.
\nIt can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.
\nThe number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
\nThese changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.
\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nIt must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
\nIt can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.
\nIt can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n
\n Amazon Aurora\n
\nNot applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nMust be in the format hh24:mi-hh24:mi
\nMust be in Universal Time Coordinated (UTC)
\nMust not conflict with the preferred maintenance window
\nMust be at least 30 minutes
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n
\n Amazon Aurora\n
\nNot applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nMust be in the format hh24:mi-hh24:mi
\nMust be in Universal Time Coordinated (UTC)
\nMust not conflict with the preferred maintenance window
\nMust be at least 30 minutes
\nThe weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.
\nFor more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n
\nDefault: Uses existing setting
\nFormat: ddd:hh24:mi-ddd:hh24:mi
\nValid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
\nConstraints: Must be at least 30 minutes
" + "smithy.api#documentation": "The weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.
\nFor more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n
\nDefault: Uses existing setting
\nFormat: ddd:hh24:mi-ddd:hh24:mi
\nValid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
\nConstraints: Must be at least 30 minutes
" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.
The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\nConstraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.
" + "smithy.api#documentation": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\nConstraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:
\nThe automatic upgrade is enabled for the maintenance window.
\nA newer minor version is available.
\nRDS has enabled automatic patching for the engine version.
\nIf any of the preceding conditions isn't met, RDS applies the change as soon as possible and\n doesn't cause an outage.
\nFor an RDS Custom DB instance, set AutoMinorVersionUpgrade \n to false. Otherwise, the operation returns an error.
A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:
\nThe automatic upgrade is enabled for the maintenance window.
\nA newer minor version is available.
\nRDS has enabled automatic patching for the engine version.
\nIf any of the preceding conditions isn't met, RDS applies the change as soon as possible and\n doesn't cause an outage.
\nFor an RDS Custom DB instance, set AutoMinorVersionUpgrade \n to false. Otherwise, the operation returns an error.
The license model for the DB instance.
\nThis setting doesn't apply to RDS Custom.
\nValid values: license-included | bring-your-own-license | \n general-public-license\n
The license model for the DB instance.
\nThis setting doesn't apply to RDS Custom.
\nValid values: license-included | bring-your-own-license | \n general-public-license\n
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
\nChanging this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
\nDefault: Uses existing setting
" + "smithy.api#documentation": "The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
\nChanging this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
\nDefault: Uses existing setting
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates the DB instance should be associated with the specified option group.
\nChanging this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.
\nThe change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates the DB instance should be associated with the specified option group.
\nChanging this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.
\nThe change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "NewDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
Specifies the storage type to be associated with the DB instance.
\nIf you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nValid values: gp2 | gp3 | io1 | standard\n
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nIf you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nValid values: gp2 | gp3 | io1 | standard\n
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" } }, "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the certificate to associate with the DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies the certificate to associate with the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected \n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
\nIf MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The interval, in seconds, between points when Enhanced Monitoring metrics are collected \n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
\nIf MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The port number on which the database accepts connections.
\nThe value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
\n\n MySQL\n
\nDefault: 3306\n
Valid values: 1150-65535\n
\n MariaDB\n
\nDefault: 3306\n
Valid values: 1150-65535\n
\n PostgreSQL\n
\nDefault: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\nDefault: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\nDefault: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\nDefault: 3306\n
Valid values: 1150-65535\n
The port number on which the database accepts connections.
\nThe value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
\n\n MySQL\n
\nDefault: 3306\n
Valid values: 1150-65535\n
\n MariaDB\n
\nDefault: 3306\n
Valid values: 1150-65535\n
\n PostgreSQL\n
\nDefault: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\nDefault: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\nDefault: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\nDefault: 3306\n
Valid values: 1150-65535\n
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.
This setting doesn't apply to RDS Custom.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom.
\nDefault: 1
\nValid Values: 0 - 15
" + "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom.
\nDefault: 1
\nValid Values: 0 - 15
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" } }, "CloudwatchLogsExportConfiguration": { "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", "traits": { - "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.
\nA change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.
\nA change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DeletionProtection": { @@ -17225,31 +17231,31 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "CertificateRotationRestart": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.
\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.
\nSet this parameter only if you are not using SSL/TLS to connect to the DB instance.
\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:
\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.\n
\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.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.
\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.
\nSet this parameter only if you are not using SSL/TLS to connect to the DB instance.
\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:
\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.\n
\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.
\nThis setting doesn't apply to RDS Custom.
" } }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "A value that sets the open mode of a replica database to either mounted or read-only.
\nCurrently, this parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that sets the open mode of a replica database to either mounted or read-only.
\nCurrently, this parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
\nThis setting doesn't apply to RDS Custom.
" } }, "AutomationMode": { @@ -17267,13 +17273,13 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
" } } }, @@ -17306,7 +17312,7 @@ } ], "traits": { - "smithy.api#documentation": "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.
The name of the DB parameter group.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
The name of the DB parameter group.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
\nValid Values (for the application method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.
When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.
You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.
For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.
", + "smithy.api#documentation": "An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
\nValid Values (for the application method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.
When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.
You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.
For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.
", "smithy.api#required": {} } } @@ -17559,7 +17565,7 @@ } ], "traits": { - "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#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.
" } }, "com.amazonaws.rds#ModifyDBSnapshotAttribute": { @@ -17582,7 +17588,7 @@ } ], "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 name of the DB snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API operation.
\nThe name of the DB snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API operation.
\nA list of DB snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.
A list of DB snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.
The engine version to upgrade the DB snapshot to.
\nThe following are the database engines and engine versions that are available when you upgrade a DB snapshot.
\n\n MySQL\n
\n\n 5.5.46 (supported for 5.1 DB snapshots)
\n Oracle\n
\n\n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
\n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
\n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
\n PostgreSQL\n
\nFor the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.
" + "smithy.api#documentation": "The engine version to upgrade the DB snapshot to.
\nThe following are the database engines and engine versions that are available when you upgrade a DB snapshot.
\n\n MySQL\n
\n\n 5.5.46 (supported for 5.1 DB snapshots)
\n Oracle\n
\n\n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
\n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
\n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
\n PostgreSQL\n
\nFor the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "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
" + "smithy.api#documentation": "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
" } } } @@ -17694,7 +17700,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
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.
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
Modify 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 action only applies to Aurora DB clusters.
\nModify 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 action only applies to Aurora DB clusters.
\nThe DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing global database cluster.
\nThe DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing global database cluster.
\nThe new cluster identifier for the global database cluster when modifying a global database cluster.\n This value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
The new cluster identifier for the global database cluster when modifying a global database cluster.\n This value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\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.
" + "smithy.api#documentation": "A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\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.
" } } } @@ -17898,7 +17904,7 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the option group to be modified.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
", + "smithy.api#documentation": "The name of the option group to be modified.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
", "smithy.api#required": {} } }, @@ -18118,7 +18124,25 @@ "OptionGroupArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the option group.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) for the option group.
" + } + }, + "SourceOptionGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the name of the option group from which this option group is copied.
" + } + }, + "SourceAccountId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the Amazon Web Services account ID for the option group from which this option group is copied.
" + } + }, + "CopyTimestamp": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "Indicates when the option group was copied.
" } } }, @@ -18292,6 +18316,12 @@ "traits": { "smithy.api#documentation": "The versions that are available for the option.
" } + }, + "CopyableCrossAccount": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "Specifies whether the option can be copied across Amazon Web Services accounts.
" + } } }, "traits": { @@ -18750,7 +18780,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether a DB instance supports RDS on Outposts.
\nFor more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Whether a DB instance supports RDS on Outposts.
\nFor more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n
" } }, "SupportedActivityStreamModes": { @@ -18770,13 +18800,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether DB instances can be configured as a Multi-AZ DB cluster.
\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": "Whether DB instances can be configured as a Multi-AZ DB cluster.
\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
" } }, "SupportedNetworkTypes": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "The network types supported by the DB instance (IPV4 or DUAL).
A DB instance 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 RDS User Guide.\n
" + "smithy.api#documentation": "The network types supported by the DB instance (IPV4 or DUAL).
A DB instance 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 RDS User Guide.\n
" } }, "SupportsStorageThroughput": { @@ -18812,7 +18842,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains a list of available options for a DB instance.
\nThis data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
Contains a list of available options for a DB instance.
\nThis data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
A data type that represents an Outpost.
\nFor more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A data type that represents an Outpost.
\nFor more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#Parameter": { @@ -18930,7 +18960,7 @@ } }, "traits": { - "smithy.api#documentation": "This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.
This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.
The date when the maintenance action is automatically applied.
\nOn this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.
" + "smithy.api#documentation": "The date when the maintenance action is automatically applied.
\nOn this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.
" } }, "OptInStatus": { @@ -19092,7 +19122,7 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The license model for the DB instance.
\nValid values: license-included | bring-your-own-license | \n general-public-license\n
The license model for the DB instance.
\nValid values: license-included | bring-your-own-license | \n general-public-license\n
Contains the processor features of a DB instance class.
\nTo specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:
\n\n CreateDBInstance\n
\n ModifyDBInstance\n
\n RestoreDBInstanceFromDBSnapshot\n
\n RestoreDBInstanceFromS3\n
\n RestoreDBInstanceToPointInTime\n
You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
\n\n DescribeDBInstances\n
\n DescribeDBSnapshots\n
\n DescribeValidDBInstanceModifications\n
If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
\nYour Oracle DB instance class supports configuring the number of CPU cores and threads per core.
\nThe current number CPU cores and threads is set to a non-default value.
\nFor more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n
" + "smithy.api#documentation": "Contains the processor features of a DB instance class.
\nTo specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:
\n\n CreateDBInstance\n
\n ModifyDBInstance\n
\n RestoreDBInstanceFromDBSnapshot\n
\n RestoreDBInstanceFromS3\n
\n RestoreDBInstanceToPointInTime\n
You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
\n\n DescribeDBInstances\n
\n DescribeDBSnapshots\n
\n DescribeValidDBInstanceModifications\n
If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
\nYour Oracle DB instance class supports configuring the number of CPU cores and threads per core.
\nThe current number CPU cores and threads is set to a non-default value.
\nFor more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n
" } }, "com.amazonaws.rds#ProcessorFeatureList": { @@ -19226,7 +19256,7 @@ } ], "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.
\nThe identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DB cluster read replica.
\nExample: my-cluster-replica1\n
The identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DB cluster read replica.
\nExample: my-cluster-replica1\n
The DB instance identifier. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing read replica DB instance.
\nExample: mydbinstance\n
The DB instance identifier. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing read replica DB instance.
\nExample: mydbinstance\n
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35.
\nCan't be set to 0 if the DB instance is a source to read replicas.
\nThe number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35.
\nCan't be set to 0 if the DB instance is a source to read replicas.
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe ID of the Reserved DB instance offering to purchase.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706
", + "smithy.api#documentation": "The ID of the Reserved DB instance offering to purchase.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706
", "smithy.api#required": {} } }, "ReservedDBInstanceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Customer-specified identifier to track this reservation.
\nExample: myreservationID
" + "smithy.api#documentation": "Customer-specified identifier to track this reservation.
\nExample: myreservationID
" } }, "DBInstanceCount": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of instances to reserve.
\nDefault: 1\n
The number of instances to reserve.
\nDefault: 1\n
You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.
\nRebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
\nUse this operation only for a non-Aurora Multi-AZ DB cluster.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.
\nRebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
\nUse this operation only for a non-Aurora Multi-AZ DB cluster.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the \n Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#RebootDBClusterMessage": { @@ -19484,7 +19514,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB cluster identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nThe DB cluster identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nYou 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.
The DB instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe DB instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nA value that indicates whether the reboot is conducted through a Multi-AZ failover.
\nConstraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
" + "smithy.api#documentation": "A value that indicates whether the reboot is conducted through a Multi-AZ failover.
\nConstraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
" } } }, @@ -19679,7 +19709,7 @@ } ], "traits": { - "smithy.api#documentation": "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.
\nRemoves 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { @@ -19883,7 +19913,7 @@ } ], "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
" } }, "com.amazonaws.rds#RemoveTagsFromResourceMessage": { @@ -20026,7 +20056,7 @@ "LeaseId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The unique identifier for the lease associated with the reserved DB instance.
\nAmazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
\nThe unique identifier for the lease associated with the reserved DB instance.
\nAmazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
\nModifies 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { @@ -20306,7 +20336,7 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group.
\nConstraints:
\nMust match the name of an existing DBParameterGroup.
The name of the DB parameter group.
\nConstraints:
\nMust match the name of an existing DBParameterGroup.
To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.
\n MySQL\n
\nValid Values (for Apply method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.
\n MariaDB\n
\nValid Values (for Apply method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.
\n Oracle\n
\nValid Values (for Apply method): pending-reboot\n
To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.
\n MySQL\n
\nValid Values (for Apply method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.
\n MariaDB\n
\nValid Values (for Apply method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.
\n Oracle\n
\nValid Values (for Apply method): pending-reboot\n
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\n 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\n MySQL.
\nThe number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nThe number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nThe name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.
Constraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nThe name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.
Constraints:
\nIf supplied, must match the name of an existing DBClusterParameterGroup.
\nA DB subnet group to associate with the restored DB cluster.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
A DB subnet group to associate with the restored DB cluster.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
The name of the database engine to be used for this DB cluster.
\nValid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql \n (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
The name of the database engine to be used for this DB cluster.
\nValid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql \n (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
The version number of the database engine to use.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1,\n 8.0.mysql_aurora.3.02.0\n
The version number of the database engine to use.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1,\n 8.0.mysql_aurora.3.02.0\n
The port number on which the instances in the restored DB cluster accept connections.
\nDefault: 3306\n
The port number on which the instances in the restored DB cluster accept connections.
\nDefault: 3306\n
The name of the master user for the restored DB cluster.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe name of the master user for the restored DB cluster.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
", + "smithy.api#documentation": "The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
", "smithy.api#required": {} } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the restored DB cluster should be associated with the specified option group.
\nPermanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.
" + "smithy.api#documentation": "A value that indicates that the restored DB cluster should be associated with the specified option group.
\nPermanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" } }, "Tags": { @@ -20536,26 +20566,26 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\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 the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\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 the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
" } }, "SourceEngine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.
\nValid values: mysql\n
The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.
\nValid values: mysql\n
The version of the database that the backup files were created from.
\nMySQL versions 5.5, 5.6, and 5.7 are supported.
\nExample: 5.6.40, 5.7.28\n
The version of the database that the backup files were created from.
\nMySQL versions 5.5, 5.6, and 5.7 are supported.
\nExample: 5.6.40, 5.7.28\n
The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\n\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\n\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" } }, "DeletionProtection": { @@ -20606,7 +20636,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
" } }, "DomainIAMRoleName": { @@ -20621,7 +20651,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "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
" + "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
" } } } @@ -20699,7 +20729,7 @@ } ], "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { @@ -20708,160 +20738,160 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.
\nValid for: Aurora DB clusters only
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "SnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier for the DB snapshot or DB cluster snapshot to restore from.
\nYou can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
\nConstraints:
\nMust match the identifier of an existing Snapshot.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The identifier for the DB snapshot or DB cluster snapshot to restore from.
\nYou can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
\nConstraints:
\nMust match the identifier of an existing Snapshot.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database engine to use for the new DB cluster.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The database engine to use for the new DB cluster.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version of the database engine to use for the new DB cluster.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.
\n\n Aurora PostgreSQL\n
\nSee Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.
\n\n MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n\n PostgreSQL\n
\nSee Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The version of the database engine to use for the new DB cluster.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.
\n\n Aurora PostgreSQL\n
\nSee Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.
\n\n MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n\n PostgreSQL\n
\nSee Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the new DB cluster accepts connections.
\nConstraints: This value must be 1150-65535\n
Default: The same port as the original DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The port number on which the new DB cluster accepts connections.
\nConstraints: This value must be 1150-65535\n
Default: The same port as the original DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB subnet group to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DB subnet group.
\nExample: mydbsubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the DB subnet group to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DB subnet group.
\nExample: mydbsubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database name for the restored DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The database name for the restored DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the option group to use for the restored DB cluster.
\nDB clusters are associated with a default option group that can't be modified.
" + "smithy.api#documentation": "The name of the option group to use for the restored DB cluster.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of VPC security groups that the new DB cluster will belong to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A list of VPC security groups that the new DB cluster will belong to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "The tags to be assigned to the restored DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The tags to be assigned to the restored DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.
\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.
\nWhen you don't specify a value for the KmsKeyId parameter, then the\n following occurs:
If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.
If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.
\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.
\nWhen you don't specify a value for the KmsKeyId parameter, then the\n following occurs:
If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.
If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora DB clusters only
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.
For more information, see \n CreateDBCluster.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.
For more information, see \n CreateDBCluster.
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.
\nConstraints:
\nIf supplied, must match the name of an existing default DB cluster parameter group.
\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.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.
\nConstraints:
\nIf supplied, must match the name of an existing default DB cluster parameter group.
\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.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" } }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\nValid values: io1\n
When specified, a value for the Iops parameter is required.
Default: io1\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\nValid values: io1\n
When specified, a value for the Iops parameter is required.
Default: io1\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "ServerlessV2ScalingConfiguration": { @@ -20870,7 +20900,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "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
" + "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
" } } }, @@ -20951,7 +20981,7 @@ } ], "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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User 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 \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { @@ -20960,58 +20990,58 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the new DB cluster to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The name of the new DB cluster to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "RestoreType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The type of restore to be performed. You can specify one of the following values:
\n\n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.
\n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The type of restore to be performed. You can specify one of the following values:
\n\n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.
\n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "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#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": {} } }, "RestoreToTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "The date and time to restore the DB cluster to.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nMust be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write\n
Example: 2015-03-07T23:45:00Z\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The date and time to restore the DB cluster to.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nMust be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write\n
Example: 2015-03-07T23:45:00Z\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "UseLatestRestorableTime": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.
\nConstraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.
\nConstraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the new DB cluster accepts connections.
\nConstraints: A value from 1150-65535.
Default: The default port for the engine.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The port number on which the new DB cluster accepts connections.
\nConstraints: A value from 1150-65535.
Default: The default port for the engine.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB subnet group name to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The DB subnet group name to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the option group for the new DB cluster.
\nDB clusters are associated with a default option group that can't be modified.
" + "smithy.api#documentation": "The name of the option group for the new DB cluster.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of VPC security groups that the new DB cluster belongs to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A list of VPC security groups that the new DB cluster belongs to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Tags": { @@ -21020,91 +21050,91 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
\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.
\nYou can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
\nIf the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
\nIf DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
\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.
\nYou can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
\nIf the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
\nIf DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" + "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\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.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\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.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
" } }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\nValid values: io1\n
When specified, a value for the Iops parameter is required.
Default: io1\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\nValid values: io1\n
When specified, a value for the Iops parameter is required.
Default: io1\n
Valid for: Multi-AZ DB clusters only
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Multi-AZ DB clusters only
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
\nValid for: Multi-AZ DB clusters only
" } }, "ServerlessV2ScalingConfiguration": { @@ -21113,7 +21143,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "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
" + "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
" } } }, @@ -21206,7 +21236,7 @@ } ], "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.
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 numbers, letters, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 numbers, letters, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
The identifier for the DB snapshot to restore from.
\nConstraints:
\nMust match the identifier of an existing DBSnapshot.
\nCan't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
The identifier for the DB snapshot to restore from.
\nConstraints:
\nMust match the identifier of an existing DBSnapshot.
\nCan't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nDefault: The same DBInstanceClass as the original DB instance.
" + "smithy.api#documentation": "The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nDefault: The same DBInstanceClass as the original DB instance.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the database accepts connections.
\nDefault: The same port as the original DB instance
\nConstraints: Value must be 1150-65535\n
The port number on which the database accepts connections.
\nDefault: The same port as the original DB instance
\nConstraints: Value must be 1150-65535\n
The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a\n
The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a\n
The DB subnet group name to use for the new instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
The DB subnet group name to use for the new instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.
\nIf you restore an RDS Custom DB instance, you must disable this parameter.
" + "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.
\nIf you restore an RDS Custom DB instance, you must disable this parameter.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\nValid values: license-included | bring-your-own-license | general-public-license\n
License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\nValid values: license-included | bring-your-own-license | general-public-license\n
The database name for the restored DB instance.
\nThis parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.
" + "smithy.api#documentation": "The database name for the restored DB instance.
\nThis parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
\nThe provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n
\nConstraints: Must be an integer greater than 1000.
" + "smithy.api#documentation": "Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
\nThe provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n
\nConstraints: Must be an integer greater than 1000.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the option group to be used for the restored DB instance.
\n \n \nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The name of the option group to be used for the restored DB instance.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "Tags": { @@ -21303,73 +21333,73 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB instance.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB instance.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
\nIn most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
\nFor more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
\nIn most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
\nFor more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\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.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\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 enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" } }, "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored for the restored DB instance.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored for the restored DB instance.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" } }, "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
\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.
\nConstraints:
\nMust match the identifier of an existing Multi-AZ DB cluster snapshot.
\nCan't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier\n must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
\nCan't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
\nThe identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
\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.
\nConstraints:
\nMust match the identifier of an existing Multi-AZ DB cluster snapshot.
\nCan't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier\n must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
\nCan't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
\nAmazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom.
" } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { @@ -21507,46 +21537,46 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The DB instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The amount of storage (in gigabytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough memory for your new DB instance\n so that the restore operation can succeed.\n You can also allocate additional memory for future growth.
\nThe amount of storage (in gigabytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough memory for your new DB instance\n so that the restore operation can succeed.\n You can also allocate additional memory for future growth.
\nThe compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n
\nImporting from Amazon S3 isn't supported on the db.t2.micro DB instance class.
", + "smithy.api#documentation": "The compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n
\nImporting from Amazon S3 isn't supported on the db.t2.micro DB instance class.
", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the database engine to be used for this instance.
\nValid Values: \n mysql\n
The name of the database engine to be used for this instance.
\nValid Values: \n mysql\n
The name for the master user.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe name for the master user.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
" + "smithy.api#documentation": "The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
" } }, "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "A list of DB security groups to associate with this DB instance.
\nDefault: The default DB security group for the database engine.
" + "smithy.api#documentation": "A list of DB security groups to associate with this DB instance.
\nDefault: The default DB security group for the database engine.
" } }, "VpcSecurityGroupIds": { @@ -21558,25 +21588,25 @@ "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
A DB subnet group to associate with this DB instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n
\nConstraints:
\nMust be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nMust be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred backup window.
\nMust be at least 30 minutes.
\nThe time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n
\nConstraints:
\nMust be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nMust be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred backup window.
\nMust be at least 30 minutes.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe port number on which the database accepts connections.
\nType: Integer
\nValid Values: 1150-65535\n
Default: 3306\n
The port number on which the database accepts connections.
\nType: Integer
\nValid Values: 1150-65535\n
Default: 3306\n
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "Tags": { @@ -21648,7 +21678,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, \n you must also include a value for the Iops parameter.
Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, \n you must also include a value for the Iops parameter.
Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n
The Amazon Web Services KMS key identifier for an encrypted 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 the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier for an encrypted 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 the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.
\nIf MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
\nDefault: 0\n
The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.
\nIf MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
\nDefault: 0\n
The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.
The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "SourceEngine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the engine of your source database.
\nValid Values: \n mysql\n
The name of the engine of your source database.
\nValid Values: \n mysql\n
The version of the database that the backup files were created from.
\nMySQL versions 5.6 and 5.7 are supported.
\nExample: 5.6.40\n
The version of the database that the backup files were created from.
\nMySQL versions 5.6 and 5.7 are supported.
\nExample: 5.6.40\n
A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
" } }, "EnableCloudwatchLogsExports": { @@ -21766,19 +21796,19 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" } } } @@ -21871,7 +21901,7 @@ } ], "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.
The identifier of the source DB instance from which to restore.
\nConstraints:
\nMust match the identifier of an existing DB instance.
\nThe identifier of the source DB instance from which to restore.
\nConstraints:
\nMust match the identifier of an existing DB instance.
\nThe name of the new DB instance to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the new DB instance to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe date and time to restore from.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nCan't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z\n
The date and time to restore from.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nCan't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z\n
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.
\nConstraints: Can't be specified if the RestoreTime parameter is provided.
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.
\nConstraints: Can't be specified if the RestoreTime parameter is provided.
The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.
\nDefault: The same DBInstanceClass as the original DB instance.
" + "smithy.api#documentation": "The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.
\nDefault: The same DBInstanceClass as the original DB instance.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the database accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB instance.
" + "smithy.api#documentation": "The port number on which the database accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB instance.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a\n
The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a\n
The DB subnet group name to use for the new instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
The DB subnet group name to use for the new instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\nValid values: license-included | bring-your-own-license | general-public-license\n
License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\nValid values: license-included | bring-your-own-license | general-public-license\n
The database name for the restored DB instance.
\nThis parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
\nThe database name for the restored DB instance.
\nThis parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
\nThe database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
\nConstraints: Must be an integer greater than 1000.
\n\n SQL Server\n
\nSetting the IOPS value for the SQL Server database engine isn't supported.
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
\nConstraints: Must be an integer greater than 1000.
\n\n SQL Server\n
\nSetting the IOPS value for the SQL Server database engine isn't supported.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the option group to be used for the restored DB instance.
\n \n \nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The name of the option group to be used for the restored DB instance.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
\nThis setting doesn't apply to RDS Custom.
" } }, "CopyTagsToSnapshot": { @@ -21987,67 +22017,67 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB instance.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB instance.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nThis setting doesn't apply to RDS Custom.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nThis setting doesn't apply to RDS Custom.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\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.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\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.
\nThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "SourceDBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" } }, "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored for the restored DB instance.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored for the restored DB instance.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \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 RDS User Guide.\n
" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "Specifies the storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" } } }, @@ -22157,7 +22187,7 @@ } ], "traits": { - "smithy.api#documentation": "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.
\nThe minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
" + "smithy.api#documentation": "The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
" } }, "MaxCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
" + "smithy.api#documentation": "The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
" } }, "AutoPause": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.
\nA value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.
\nThe time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
" + "smithy.api#documentation": "The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
" } }, "TimeoutAction": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
If you specify ForceApplyCapacityChange, connections that\n prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
If you specify ForceApplyCapacityChange, connections that\n prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
" } }, "SecondsBeforeTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.
\nSpecify a value between 60 and 600 seconds.
" + "smithy.api#documentation": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.
\nSpecify a value between 60 and 600 seconds.
" } } }, "traits": { - "smithy.api#documentation": "Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
\nFor more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.
" + "smithy.api#documentation": "Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
\nFor more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#ScalingConfigurationInfo": { @@ -22320,7 +22350,7 @@ "AutoPause": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
" + "smithy.api#documentation": "A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
" } }, "SecondsUntilAutoPause": { @@ -22332,7 +22362,7 @@ "TimeoutAction": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The action that occurs when Aurora times out while attempting to change the capacity of an\n Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or\n 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 action that occurs when Aurora times out while attempting to change the capacity of an\n Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or\n 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.
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.
" + "smithy.api#documentation": "Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { @@ -22363,7 +22393,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
\nFor more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.
" + "smithy.api#documentation": "Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
\nFor more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo": { @@ -22383,7 +22413,7 @@ } }, "traits": { - "smithy.api#documentation": "Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
\nFor more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.
" + "smithy.api#documentation": "Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
\nFor more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { @@ -22733,7 +22763,7 @@ } ], "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
" } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { @@ -22857,7 +22887,7 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "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.
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 a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nThis command doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Starts an export of a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nThis command doesn't apply to RDS Custom.
" } }, "com.amazonaws.rds#StartExportTaskMessage": { @@ -22968,7 +22998,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to execute the following operations. \n These can be set in the Amazon Web Services KMS key policy:
\nGrantOperation.Encrypt
\nGrantOperation.Decrypt
\nGrantOperation.GenerateDataKey
\nGrantOperation.GenerateDataKeyWithoutPlaintext
\nGrantOperation.ReEncryptFrom
\nGrantOperation.ReEncryptTo
\nGrantOperation.CreateGrant
\nGrantOperation.DescribeKey
\nGrantOperation.RetireGrant
\nThe ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to execute the following operations. \n These can be set in the Amazon Web Services KMS key policy:
\nGrantOperation.Encrypt
\nGrantOperation.Decrypt
\nGrantOperation.GenerateDataKey
\nGrantOperation.GenerateDataKeyWithoutPlaintext
\nGrantOperation.ReEncryptFrom
\nGrantOperation.ReEncryptTo
\nGrantOperation.CreateGrant
\nGrantOperation.DescribeKey
\nGrantOperation.RetireGrant
\nThe data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot 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. 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. \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.
The data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot 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. 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. \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 Database Activity Streams\n in the Amazon Aurora 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 Database Activity Streams\n in the Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#StopActivityStreamRequest": { @@ -23039,7 +23069,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "KinesisStreamName": { @@ -23076,7 +23106,7 @@ } ], "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
" } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { @@ -23262,7 +23292,7 @@ "SubnetOutpost": { "target": "com.amazonaws.rds#Outpost", "traits": { - "smithy.api#documentation": "If the subnet is associated with an Outpost, this value specifies the Outpost.
\nFor more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "If the subnet is associated with an Outpost, this value specifies the Outpost.
\nFor more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n
" } }, "SubnetStatus": { @@ -23397,7 +23427,7 @@ } ], "traits": { - "smithy.api#documentation": "Switches over a blue/green deployment.
\nBefore you switch over, production traffic is routed to the databases in the blue environment. \n After you switch over, production traffic is routed to the databases in the green environment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "Switches over a blue/green deployment.
\nBefore you switch over, production traffic is routed to the databases in the blue environment. \n After you switch over, production traffic is routed to the databases in the green environment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" } }, "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest": { @@ -23406,14 +23436,14 @@ "BlueGreenDeploymentIdentifier": { "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", "traits": { - "smithy.api#documentation": "The blue/green deployment identifier.
\nConstraints:
\nMust match an existing blue/green deployment identifier.
\nThe blue/green deployment identifier.
\nConstraints:
\nMust match an existing blue/green deployment identifier.
\nThe amount of time, in seconds, for the switchover to complete. The default is 300.
\nIf the switchover takes longer than the specified duration, then any changes are rolled back, \n and no changes are made to the environments.
" + "smithy.api#documentation": "The amount of time, in seconds, for the switchover to complete. The default is 300.
\nIf the switchover takes longer than the specified duration, then any changes are rolled back, \n and no changes are made to the environments.
" } } } @@ -23444,12 +23474,12 @@ "Status": { "target": "com.amazonaws.rds#SwitchoverDetailStatus", "traits": { - "smithy.api#documentation": "The switchover status of a resource in a blue/green deployment.
\nValues:
\n\n preparing-for-switchover - The resource is being prepared to switch over.
\n ready-for-switchover - The resource is ready to switch\n over.
\n switchover-in-progress - The resource is being switched over.
\n switchover-completed - The resource has been switched over.
\n switchover-failed - The resource attempted to switch over but failed.
The switchover status of a resource in a blue/green deployment.
\nValues:
\n\n preparing-for-switchover - The resource is being prepared to switch over.
\n ready-for-switchover - The resource is ready to switch\n over.
\n switchover-in-progress - The resource is being switched over.
\n switchover-completed - The resource has been switched over.
\n switchover-failed - The resource attempted to switch over but failed.
Contains the details about a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "Contains the details about a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" } }, "com.amazonaws.rds#SwitchoverDetailList": { @@ -23487,7 +23517,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB instance identifier of the current standby database. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing Oracle read replica DB instance.
\nThe DB instance identifier of the current standby database. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing Oracle read replica DB instance.
\nMetadata assigned to an Amazon RDS resource consisting of a key-value pair.
\nFor more information, see Tagging \n Amazon RDS Resources in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
\nFor more information, see Tagging \n Amazon RDS Resources in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#TagList": { @@ -23600,7 +23630,7 @@ "State": { "target": "com.amazonaws.rds#TargetState", "traits": { - "smithy.api#documentation": "The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:
\n\n registering > unavailable > available > unavailable > available\n
The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:
\n\n registering > unavailable > available > unavailable > available\n
The membership status of the VPC security group.
\nCurrently, the only valid status is active.
The membership status of the VPC security group.
\nCurrently, the only valid status is active.
Compares a face in the source input image with each of the 100\n largest faces detected in the target input image.
\nIf the source image contains multiple faces, the service detects the largest face and\n compares it with each face detected in the target image.
\nCompareFaces uses machine learning algorithms, which are probabilistic. A false negative\n is an incorrect prediction that a face in the target image has a low similarity confidence\n score when compared to the face in the source image. To reduce the probability of false\n negatives, we recommend that you compare the target image against multiple source images. If\n you plan to use CompareFaces to make a decision that impacts an individual's\n rights, privacy, or access to services, we recommend that you pass the result to a human for\n review and further validation before taking action.
You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.
\nIn response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.
\nBy default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.
\n CompareFaces also returns an array of faces that don't match the source\n image. For each face, it returns a bounding box, confidence value, landmarks, pose details,\n and quality. The response also returns information about the face in the source image,\n including the bounding box of the face and confidence value.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar by specifying LOW,\n MEDIUM, or HIGH. If you do not want to filter detected faces,\n specify NONE. The default value is NONE.
If the image doesn't contain Exif metadata, CompareFaces returns\n orientation information for the source and target images. Use these values to display the\n images with the correct image orientation.
If no faces are detected in the source or target images, CompareFaces\n returns an InvalidParameterException error.
This is a stateless API operation. That is, data returned by this operation doesn't\n persist.
\nFor an example, see Comparing Faces in Images in the Amazon Rekognition Developer\n Guide.
\nThis operation requires permissions to perform the\n rekognition:CompareFaces action.
Compares a face in the source input image with each of the 100\n largest faces detected in the target input image.
\nIf the source image contains multiple faces, the service detects the largest face and\n compares it with each face detected in the target image.
\nCompareFaces uses machine learning algorithms, which are probabilistic. A false negative\n is an incorrect prediction that a face in the target image has a low similarity confidence\n score when compared to the face in the source image. To reduce the probability of false\n negatives, we recommend that you compare the target image against multiple source images. If\n you plan to use CompareFaces to make a decision that impacts an individual's\n rights, privacy, or access to services, we recommend that you pass the result to a human for\n review and further validation before taking action.
You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.
\nIn response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.
\nBy default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.
\n CompareFaces also returns an array of faces that don't match the source\n image. For each face, it returns a bounding box, confidence value, landmarks, pose details,\n and quality. The response also returns information about the face in the source image,\n including the bounding box of the face and confidence value.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar by specifying LOW,\n MEDIUM, or HIGH. If you do not want to filter detected faces,\n specify NONE. The default value is NONE.
If the image doesn't contain Exif metadata, CompareFaces returns\n orientation information for the source and target images. Use these values to display the\n images with the correct image orientation.
If no faces are detected in the source or target images, CompareFaces\n returns an InvalidParameterException error.
This is a stateless API operation. That is, data returned by this operation doesn't\n persist.
\nFor an example, see Comparing Faces in Images in the Amazon Rekognition Developer\n Guide.
\nThis operation requires permissions to perform the\n rekognition:CompareFaces action.
Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n
\nTo copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.
\n \n \nFor more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nIf you are copying a model version to a project in the same AWS account, you don't need to create a project policy.
\nTo copy a model, the destination project, source project, and source model version must already exist.
\nCopying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.
Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n
\nTo copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.
\nFor more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nIf you are copying a model version to a project in the same AWS account, you don't need to create a project policy.
\nTo copy a model, the destination project, source project, and source model version must already exist.
\nCopying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.
The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
\nkms:CreateGrant
\nkms:DescribeKey
\nkms:GenerateDataKey
\nkms:Decrypt
\nIf you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.
The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
\nkms:CreateGrant
\nkms:DescribeKey
\nkms:GenerateDataKey
\nkms:Decrypt
\nIf you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.
Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using\n an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.
\n\nTo create a training dataset for a project, specify train for the value of \n DatasetType. To create the test dataset for a project,\n specify test for the value of DatasetType.\n
The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset.\n Creating a dataset takes a while to complete. Use DescribeDataset to check the \n current status. The dataset created successfully if the value of Status is\n CREATE_COMPLETE.
To check if any non-terminal errors occurred, call ListDatasetEntries\nand check for the presence of errors lists in the JSON Lines.
Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). \n Currently, you can't access the terminal error information.\n \n
For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.
\n \nThis operation requires permissions to perform the rekognition:CreateDataset action.\n If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.
Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using\n an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.
\nTo create a training dataset for a project, specify train for the value of \n DatasetType. To create the test dataset for a project,\n specify test for the value of DatasetType.\n
The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset.\n Creating a dataset takes a while to complete. Use DescribeDataset to check the \n current status. The dataset created successfully if the value of Status is\n CREATE_COMPLETE.
To check if any non-terminal errors occurred, call ListDatasetEntries\nand check for the presence of errors lists in the JSON Lines.
Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). \n Currently, you can't access the terminal error information.\n \n
For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.
\nThis operation requires permissions to perform the rekognition:CreateDataset action.\n If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.
Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. \n The response from CreateProjectVersion\n is an Amazon Resource Name (ARN) for the version of the model.
Training uses the training and test datasets associated with the project. \n For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.\n
\n \n \nYou can train a model in a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData and TestingData fields.\n
If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.
\nInstead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.
\nTraining takes a while to complete. You can get the current status by calling\n DescribeProjectVersions. Training completed successfully if\n the value of the Status field is TRAINING_COMPLETED.
If training \n fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.
\n \n \nOnce training has successfully completed, call DescribeProjectVersions to\n get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model\n in the Amazon Rekognition Custom Labels developers guide.\n
\n \nAfter evaluating the model, you start the model\n by calling StartProjectVersion.
\nThis operation requires permissions to perform the rekognition:CreateProjectVersion action.
Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. \n The response from CreateProjectVersion\n is an Amazon Resource Name (ARN) for the version of the model.
Training uses the training and test datasets associated with the project. \n For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.\n
\nYou can train a model in a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData and TestingData fields.\n
If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.
\nInstead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.
\nTraining takes a while to complete. You can get the current status by calling\n DescribeProjectVersions. Training completed successfully if\n the value of the Status field is TRAINING_COMPLETED.
If training \n fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.
\nOnce training has successfully completed, call DescribeProjectVersions to\n get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model\n in the Amazon Rekognition Custom Labels developers guide.\n
\nAfter evaluating the model, you start the model\n by calling StartProjectVersion.
\nThis operation requires permissions to perform the rekognition:CreateProjectVersion action.
The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training and test images copied into the service for model training.\n Your source images are unaffected. The key is also used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
\nkms:CreateGrant
\nkms:DescribeKey
\nkms:GenerateDataKey
\nkms:Decrypt
\nIf you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.
The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training and test images copied into the service for model training.\n Your source images are unaffected. The key is also used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
\nkms:CreateGrant
\nkms:DescribeKey
\nkms:GenerateDataKey
\nkms:Decrypt
\nIf you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.
\nAmazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.
\nIf you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the\n face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to\n stop processing.
If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (Input), Amazon S3 bucket information (Output), and an\n Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket.\n You specify what you want to detect in ConnectedHomeSettings, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. \n When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.
\n Use Name to assign an identifier for the stream processor. You use Name\n to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with\n the Name field.
This operation requires permissions to perform the\n rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.
\nAmazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.
\nIf you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the\n face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to\n stop processing.
If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (Input), Amazon S3 bucket information (Output), and an\n Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket.\n You specify what you want to detect in ConnectedHomeSettings, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. \n When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.
\n Use Name to assign an identifier for the stream processor. You use Name\n to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with\n the Name field.
This operation requires permissions to perform the\n rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.
\n The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. \n The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected. \n
\n\n
" + "smithy.api#documentation": "\n The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. \n The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected. \n
\n\n
" } }, "RegionsOfInterest": { @@ -1390,7 +1390,7 @@ "GroundTruth": { "target": "com.amazonaws.rekognition#GroundTruthBlob", "traits": { - "smithy.api#documentation": "A Base64-encoded binary data object\n containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling UpdateDatasetEntries.\n If you are using an AWS SDK to call UpdateDatasetEntries, you don't need to encode Changes as the SDK encodes the data for you.\n\n
For example JSON lines,\n see Image-Level labels in manifest files and \n and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n
", + "smithy.api#documentation": "A Base64-encoded binary data object\n containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling UpdateDatasetEntries.\n If you are using an AWS SDK to call UpdateDatasetEntries, you don't need to encode Changes as the SDK encodes the data for you.\n\n
For example JSON lines,\n see Image-Level labels in manifest files and \n and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n
", "smithy.api#required": {} } } @@ -2156,7 +2156,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified collection. You can use DescribeCollection to get\n information, such as the number of faces indexed into a collection and the version of the\n model used by the collection for face detection.
For more information, see Describing a Collection in the \n Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "Describes the specified collection. You can use DescribeCollection to get\n information, such as the number of faces indexed into a collection and the version of the\n model used by the collection for face detection.
For more information, see Describing a Collection in the \n Amazon Rekognition Developer Guide.
" } }, "com.amazonaws.rekognition#DescribeCollectionRequest": { @@ -2183,7 +2183,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "The version of the face model that's used by the collection for face detection.
\n \nFor more information, see Model versioning in the \n Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "The version of the face model that's used by the collection for face detection.
\nFor more information, see Model versioning in the \n Amazon Rekognition Developer Guide.
" } }, "CollectionARN": { @@ -2649,7 +2649,7 @@ } ], "traits": { - "smithy.api#documentation": "Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.
\nYou specify which version of a model version to use by using the ProjectVersionArn input\n parameter.
You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing\n image bytes is not supported. The image must be either a PNG or JPEG formatted file.
\n For each object that the model version detects on an image, the API returns a \n (CustomLabel) object in an array (CustomLabels).\n Each CustomLabel object provides the label name (Name), the level\n of confidence that the image contains the object (Confidence), and \n object location information, if it exists, for the label on the image (Geometry).
To filter labels that are returned, specify a value for MinConfidence.\n DetectCustomLabelsLabels only returns labels with a confidence that's higher than\n the specified value.\n\n The value of MinConfidence maps to the assumed threshold values\n created during training. For more information, see Assumed threshold\n in the Amazon Rekognition Custom Labels Developer Guide. \n Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of\n MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence\n responses from DetectCustomLabels are also returned as a percentage. \n You can use MinConfidence to change the precision and recall or your model. \n For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.
This is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the\n rekognition:DetectCustomLabels action.
For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
" + "smithy.api#documentation": "Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.
\nYou specify which version of a model version to use by using the ProjectVersionArn input\n parameter.
You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing\n image bytes is not supported. The image must be either a PNG or JPEG formatted file.
\n For each object that the model version detects on an image, the API returns a \n (CustomLabel) object in an array (CustomLabels).\n Each CustomLabel object provides the label name (Name), the level\n of confidence that the image contains the object (Confidence), and \n object location information, if it exists, for the label on the image (Geometry).
To filter labels that are returned, specify a value for MinConfidence.\n DetectCustomLabelsLabels only returns labels with a confidence that's higher than\n the specified value.\n\n The value of MinConfidence maps to the assumed threshold values\n created during training. For more information, see Assumed threshold\n in the Amazon Rekognition Custom Labels Developer Guide. \n Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of\n MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence\n responses from DetectCustomLabels are also returned as a percentage. \n You can use MinConfidence to change the precision and recall or your model. \n For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.
This is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the\n rekognition:DetectCustomLabels action.
For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
" } }, "com.amazonaws.rekognition#DetectCustomLabelsRequest": { @@ -2801,7 +2801,7 @@ } ], "traits": { - "smithy.api#documentation": "Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.
\n \nFor an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.
\n \nYou pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n\n Optional Parameters\n
\nYou can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.
When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.
You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 55%. You can also add the MaxLabels parameter to\n limit the number of labels returned. The default and upper limit is 1000 labels.
\n Response Elements\n
\nFor each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information regarding labels:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.\n
\nParents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to. A given label\n can belong to more than one category.
\nBoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.
\nThe API returns the following information regarding the image, as part of the\n ImageProperties structure:
\nQuality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.
\nDominant Color - An array of the dominant colors in the image.
\nForeground - Information about the Sharpness and Brightness of the input image’s\n foreground.
\nBackground - Information about the Sharpness and Brightness of the input image’s\n background.
\nThe list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:
\n\n {Name: lighthouse, Confidence: 98.4629}\n
\n {Name: rock,Confidence: 79.2097}\n
\n {Name: sea,Confidence: 75.061}\n
The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.
\n\n {Name: flower,Confidence: 99.0562}\n
\n {Name: plant,Confidence: 99.0562}\n
\n {Name: tulip,Confidence: 99.0562}\n
In this example, the detection algorithm more precisely identifies the flower as a\n tulip.
\nIf the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.
\nThis is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the\n rekognition:DetectLabels action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.
\nFor an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n\n Optional Parameters\n
\nYou can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.
When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.
You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 55%. You can also add the MaxLabels parameter to\n limit the number of labels returned. The default and upper limit is 1000 labels.
\n Response Elements\n
\nFor each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information regarding labels:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.\n
\nParents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.
\nThe API returns the following information regarding the image, as part of the\n ImageProperties structure:
\nQuality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.
\nDominant Color - An array of the dominant colors in the image.
\nForeground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.
\nBackground - Information about the sharpness, brightness, and dominant colors of the input image’s background.
\nThe list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:
\n\n {Name: lighthouse, Confidence: 98.4629}\n
\n {Name: rock,Confidence: 79.2097}\n
\n {Name: sea,Confidence: 75.061}\n
The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.
\n\n {Name: flower,Confidence: 99.0562}\n
\n {Name: plant,Confidence: 99.0562}\n
\n {Name: tulip,Confidence: 99.0562}\n
In this example, the detection algorithm more precisely identifies the flower as a\n tulip.
\nIf the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.
\nThis is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the\n rekognition:DetectLabels action.
Detects unsafe content in a specified JPEG or PNG format image. Use\n DetectModerationLabels to moderate images depending on your requirements. For\n example, you might want to filter images that contain nudity, but not images containing\n suggestive content.
To filter images, use the labels returned by DetectModerationLabels to\n determine which types of content are appropriate.
For information about moderation labels, see Detecting Unsafe Content in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
" + "smithy.api#documentation": "Detects unsafe content in a specified JPEG or PNG format image. Use\n DetectModerationLabels to moderate images depending on your requirements. For\n example, you might want to filter images that contain nudity, but not images containing\n suggestive content.
To filter images, use the labels returned by DetectModerationLabels to\n determine which types of content are appropriate.
For information about moderation labels, see Detecting Unsafe Content in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
" } }, "com.amazonaws.rekognition#DetectModerationLabelsRequest": { @@ -3164,7 +3164,7 @@ } ], "traits": { - "smithy.api#documentation": "Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the \n following types of PPE.
\nFace cover
\nHand cover
\nHead cover
\nYou pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.\n The image must be either a PNG or JPG formatted file.
\n \n\n DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.
For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).\n For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE\n covers the body part. The API returns the confidence it has in each detection\n (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected \n person and each detected item of PPE.
\nYou can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter.\n The summary provides the following information.
The persons detected as wearing all of the types of PPE that you specify.
\nThe persons detected as not wearing all of the types PPE that you specify.
\nThe persons detected where PPE adornment could not be determined.
\nThis is a stateless API operation. That is, the operation does not persist any data.
\n \nThis operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.
Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the \n following types of PPE.
\nFace cover
\nHand cover
\nHead cover
\nYou pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.\n The image must be either a PNG or JPG formatted file.
\n\n DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.
For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).\n For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE\n covers the body part. The API returns the confidence it has in each detection\n (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected \n person and each detected item of PPE.
\nYou can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter.\n The summary provides the following information.
The persons detected as wearing all of the types of PPE that you specify.
\nThe persons detected as not wearing all of the types PPE that you specify.
\nThe persons detected where PPE adornment could not be determined.
\nThis is a stateless API operation. That is, the operation does not persist any data.
\nThis operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.
Detects text in the input image and converts it into machine-readable text.
\nPass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.
\nThe DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.
A word is one or more script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.
A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.
To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.
To be detected, text must be within +/- 90 degrees orientation of the horizontal\n axis.
\n \nFor more information, see Detecting text in the Amazon Rekognition Developer\n Guide.
" + "smithy.api#documentation": "Detects text in the input image and converts it into machine-readable text.
\nPass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.
\nThe DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.
A word is one or more script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.
A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.
To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.
To be detected, text must be within +/- 90 degrees orientation of the horizontal\n axis.
\nFor more information, see Detecting text in the Amazon Rekognition Developer\n Guide.
" } }, "com.amazonaws.rekognition#DetectTextFilters": { @@ -3371,7 +3371,7 @@ } ], "traits": { - "smithy.api#documentation": "Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.\n DistributeDatasetEntries moves 20% of the training dataset images to the test dataset.\n An entry is a JSON Line that describes an image.\n
You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.
\nDistributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.
This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.
Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.\n DistributeDatasetEntries moves 20% of the training dataset images to the test dataset.\n An entry is a JSON Line that describes an image.\n
You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.
\nDistributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.
This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.
Structure containing attributes of the face that the algorithm detected.
\nA FaceDetail object contains either the default facial attributes or all\n facial attributes. The default attributes are BoundingBox,\n Confidence, Landmarks, Pose, and\n Quality.
\n GetFaceDetection is the only Amazon Rekognition Video stored video operation that can\n return a FaceDetail object with all attributes. To specify which attributes to\n return, use the FaceAttributes input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default\n attributes. The corresponding Start operations don't have a FaceAttributes input\n parameter.
GetCelebrityRecognition
\nGetPersonTracking
\nGetFaceSearch
\nThe Amazon Rekognition Image DetectFaces and IndexFaces operations\n can return all facial attributes. To specify which attributes to return, use the\n Attributes input parameter for DetectFaces. For\n IndexFaces, use the DetectAttributes input parameter.
Structure containing attributes of the face that the algorithm detected.
\nA FaceDetail object contains either the default facial attributes or all\n facial attributes. The default attributes are BoundingBox,\n Confidence, Landmarks, Pose, and\n Quality.
\n GetFaceDetection is the only Amazon Rekognition Video stored video operation that can\n return a FaceDetail object with all attributes. To specify which attributes to\n return, use the FaceAttributes input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default\n attributes. The corresponding Start operations don't have a FaceAttributes input\n parameter:
GetCelebrityRecognition
\nGetPersonTracking
\nGetFaceSearch
\nThe Amazon Rekognition Image DetectFaces and IndexFaces operations\n can return all facial attributes. To specify which attributes to return, use the\n Attributes input parameter for DetectFaces. For\n IndexFaces, use the DetectAttributes input parameter.
Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.\n The additional information is returned as an array of URLs. If there is no additional\n information about the celebrity, this list is empty.
\n \nFor more information, see Getting information about a celebrity in the\n Amazon Rekognition Developer Guide.
\nThis operation requires permissions to perform the\n rekognition:GetCelebrityInfo action.
Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.\n The additional information is returned as an array of URLs. If there is no additional\n information about the celebrity, this list is empty.
\nFor more information, see Getting information about a celebrity in the\n Amazon Rekognition Developer Guide.
\nThis operation requires permissions to perform the\n rekognition:GetCelebrityInfo action.
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by\n StartCelebrityRecognition.
\nCelebrity recognition in a video is an asynchronous operation. Analysis is started by a\n call to StartCelebrityRecognition which returns a job identifier\n (JobId).
When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion\n status to the Amazon Simple Notification Service topic registered in the initial call to\n StartCelebrityRecognition. To get the results of the celebrity recognition\n analysis, first check that the status value published to the Amazon SNS topic is\n SUCCEEDED. If so, call GetCelebrityDetection and pass the job\n identifier (JobId) from the initial call to StartCelebrityDetection.
For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.
\n\n GetCelebrityRecognition returns detected celebrities and the time(s) they\n are detected in an array (Celebrities) of CelebrityRecognition\n objects. Each CelebrityRecognition\n contains information about the celebrity in a CelebrityDetail object and the\n time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face\n attributes, a face bounding box, known gender, the celebrity's name, and a confidence\n estimate.
\n GetCelebrityRecognition only returns the default facial\n attributes (BoundingBox, Confidence, Landmarks,\n Pose, and Quality). The BoundingBox field only\n applies to the detected face instance. The other facial attributes listed in the\n Face object of the following response syntax are not returned. For more\n information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities array is sorted by time (milliseconds from the start of the video).\n You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.
The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store\n the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.
No information is returned for faces not recognized as celebrities.
\nUse MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection\n and populate the NextToken request parameter with the token\n value returned from the previous call to GetCelebrityRecognition.
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by\n StartCelebrityRecognition.
\nCelebrity recognition in a video is an asynchronous operation. Analysis is started by a\n call to StartCelebrityRecognition which returns a job identifier\n (JobId).
When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion\n status to the Amazon Simple Notification Service topic registered in the initial call to\n StartCelebrityRecognition. To get the results of the celebrity recognition\n analysis, first check that the status value published to the Amazon SNS topic is\n SUCCEEDED. If so, call GetCelebrityDetection and pass the job\n identifier (JobId) from the initial call to StartCelebrityDetection.
For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.
\n\n GetCelebrityRecognition returns detected celebrities and the time(s) they\n are detected in an array (Celebrities) of CelebrityRecognition\n objects. Each CelebrityRecognition\n contains information about the celebrity in a CelebrityDetail object and the\n time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face\n attributes, a face bounding box, known gender, the celebrity's name, and a confidence\n estimate.
\n GetCelebrityRecognition only returns the default facial\n attributes (BoundingBox, Confidence, Landmarks,\n Pose, and Quality). The BoundingBox field only\n applies to the detected face instance. The other facial attributes listed in the\n Face object of the following response syntax are not returned. For more\n information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities array is sorted by time (milliseconds from the start of the video).\n You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.
The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store\n the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.
No information is returned for faces not recognized as celebrities.
\nUse MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection\n and populate the NextToken request parameter with the token\n value returned from the previous call to GetCelebrityRecognition.
Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by\n StartContentModeration. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.
\n\nAmazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling\n StartContentModeration which returns a job identifier (JobId).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartContentModeration.\n To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.
For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.
\n\n GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels,\n and the time they are detected, in an array, ModerationLabels, of\n ContentModerationDetection objects.\n
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying NAME for the SortBy\n input parameter.
Since video analysis can return a large number of results, use the MaxResults parameter to limit\n the number of labels returned in a single call to GetContentModeration. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetContentModeration\n and populate the NextToken request parameter with the value of NextToken\n returned from the previous call to GetContentModeration.
For more information, see moderating content in the Amazon Rekognition Developer Guide.
", + "smithy.api#documentation": "Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by\n StartContentModeration. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.
\nAmazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling\n StartContentModeration which returns a job identifier (JobId).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartContentModeration.\n To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.
For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.
\n\n GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels,\n and the time they are detected, in an array, ModerationLabels, of\n ContentModerationDetection objects.\n
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying NAME for the SortBy\n input parameter.
Since video analysis can return a large number of results, use the MaxResults parameter to limit\n the number of labels returned in a single call to GetContentModeration. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetContentModeration\n and populate the NextToken request parameter with the value of NextToken\n returned from the previous call to GetContentModeration.
For more information, see moderating content in the Amazon Rekognition Developer Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4510,7 +4510,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the face search results for Amazon Rekognition Video face search started by\n StartFaceSearch. The search returns faces in a collection that match the faces\n of persons detected in a video. It also includes the time(s) that faces are matched in the video.
\nFace search in a video is an asynchronous operation. You start face search by calling\n to StartFaceSearch which returns a job identifier (JobId).\n When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartFaceSearch.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier\n (JobId) from the initial call to StartFaceSearch.
For more information, see Searching Faces in a Collection in the\n Amazon Rekognition Developer Guide.
\nThe search results are retured in an array, Persons, of\n PersonMatch objects. EachPersonMatch element contains\n details about the matching faces in the input collection, person information (facial attributes,\n bounding boxes, and person identifer)\n for the matched person, and the time the person was matched in the video.
\n GetFaceSearch only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons array is sorted by the time, in milliseconds from the\n start of the video, persons are matched.\n You can also sort by persons by specifying INDEX for the SORTBY input\n parameter.
Gets the face search results for Amazon Rekognition Video face search started by\n StartFaceSearch. The search returns faces in a collection that match the faces\n of persons detected in a video. It also includes the time(s) that faces are matched in the video.
\nFace search in a video is an asynchronous operation. You start face search by calling\n to StartFaceSearch which returns a job identifier (JobId).\n When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartFaceSearch.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier\n (JobId) from the initial call to StartFaceSearch.
For more information, see Searching Faces in a Collection in the\n Amazon Rekognition Developer Guide.
\nThe search results are retured in an array, Persons, of\n PersonMatch objects. EachPersonMatch element contains\n details about the matching faces in the input collection, person information (facial attributes,\n bounding boxes, and person identifer)\n for the matched person, and the time the person was matched in the video.
\n GetFaceSearch only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons array is sorted by the time, in milliseconds from the\n start of the video, persons are matched.\n You can also sort by persons by specifying INDEX for the SORTBY input\n parameter.
Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
\n\nThe label detection operation is started by a call to StartLabelDetection\n which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results\n of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetLabelDetection and pass the job identifier\n (JobId) from the initial call to StartLabelDetection.
\n GetLabelDetection returns an array of detected labels (Labels) sorted by the time\n the labels were detected. You can also sort by the label name by specifying NAME for the\n SortBy input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label,\n and the time the label was detected in the video.
\nThe returned labels also include bounding box information for common objects, a \n hierarchical taxonomy of detected labels, and the version of the label model used for detection.
\n \nUse MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token\n value returned from the previous call to GetLabelDetection.
Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
\nThe label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When\n the label detection operation finishes, Amazon Rekognition publishes a completion status to the\n Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection.
To get the results of the label detection operation, first check that the status value\n published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the\n initial call to StartLabelDetection.
\n GetLabelDetection returns an array of detected labels\n (Labels) sorted by the time the labels were detected. You can also sort by the\n label name by specifying NAME for the SortBy input parameter. If\n there is no NAME specified, the default sort is by\n timestamp.
You can select how results are aggregated by using the AggregateBy input\n parameter. The default aggregation method is TIMESTAMPS. You can also aggregate\n by SEGMENTS, which aggregates all instances of labels detected in a given\n segment.
The returned Labels array may include the following attributes:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.
\nParents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical\n taxonomy of detected labels. For example, a detected car might be assigned the label car.\n The label car has two parent labels: Vehicle (its parent) and Transportation (its\n grandparent). The response includes the all ancestors for a label, where every ancestor is\n a unique label. In the previous example, Car, Vehicle, and Transportation are returned as\n unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common object labels, \n returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing \n the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.
\nTimestamp - Time, in milliseconds from the start of the video, that the label was detected.\n For aggregation by SEGMENTS, the StartTimestampMillis,\n EndTimestampMillis, and DurationMillis structures are what\n define a segment. Although the “Timestamp” structure is still returned with each label,\n its value is set to be the same as StartTimestampMillis.
Timestamp and Bounding box information are returned for detected Instances, only if\n aggregation is done by TIMESTAMPS. If aggregating by SEGMENTS,\n information about detected instances isn’t returned.
The version of the label model used for the detection is also returned.
\n\n Note DominantColors isn't returned for Instances,\n although it is shown as part of the response in the sample seen below.\n
Use MaxResults parameter to limit the number of labels returned. If\n there are more results than specified in MaxResults, the value of\n NextToken in the operation response contains a pagination token for getting the\n next set of results. To get the next page of results, call GetlabelDetection and\n populate the NextToken request parameter with the token value returned from the\n previous call to GetLabelDetection.
Sort to use for elements in the Labels array.\n Use TIMESTAMP to sort array elements by the time labels are detected.\n Use NAME to alphabetically group elements for a label together.\n Within each label group, the array element are sorted by detection confidence.\n The default sort is by TIMESTAMP.
Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
" + } } } }, @@ -4726,7 +4732,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.
\n\nThe person path tracking operation is started by a call to StartPersonTracking\n which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.
To get the results of the person path tracking operation, first check \n that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetPersonTracking and pass the job identifier\n (JobId) from the initial call to StartPersonTracking.
\n GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their \n paths were tracked in the video.
\n GetPersonTracking only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned.
For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
\nBy default, the array is sorted by the time(s) a person's path is tracked in the video.\n You can sort by tracked persons by specifying INDEX for the SortBy input parameter.
Use the MaxResults parameter to limit the number of items returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token\n value returned from the previous call to GetPersonTracking.
Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.
\nThe person path tracking operation is started by a call to StartPersonTracking\n which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.
To get the results of the person path tracking operation, first check \n that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetPersonTracking and pass the job identifier\n (JobId) from the initial call to StartPersonTracking.
\n GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their \n paths were tracked in the video.
\n GetPersonTracking only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned.
For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
\nBy default, the array is sorted by the time(s) a person's path is tracked in the video.\n You can sort by tracked persons by specifying INDEX for the SortBy input parameter.
Use the MaxResults parameter to limit the number of items returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token\n value returned from the previous call to GetPersonTracking.
Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.
\nSegment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by \n calling StartSegmentDetection which returns a job identifier (JobId).\n When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartSegmentDetection. To get the results\n of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call\n of StartSegmentDetection.
\n GetSegmentDetection returns detected segments in an array (Segments)\n of SegmentDetection objects. Segments is sorted by the segment types \n specified in the SegmentTypes input parameter of StartSegmentDetection. \n Each element of the array includes the detected segment, the precentage confidence in the acuracy \n of the detected segment, the type of the segment, and the frame in which the segment was detected.
Use SelectedSegmentTypes to find out the type of segment detection requested in the \n call to StartSegmentDetection.
Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetSegmentDetection.
For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.
", + "smithy.api#documentation": "Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.
\nSegment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by \n calling StartSegmentDetection which returns a job identifier (JobId).\n When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartSegmentDetection. To get the results\n of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call\n of StartSegmentDetection.
\n GetSegmentDetection returns detected segments in an array (Segments)\n of SegmentDetection objects. Segments is sorted by the segment types \n specified in the SegmentTypes input parameter of StartSegmentDetection. \n Each element of the array includes the detected segment, the precentage confidence in the acuracy \n of the detected segment, the type of the segment, and the frame in which the segment was detected.
Use SelectedSegmentTypes to find out the type of segment detection requested in the \n call to StartSegmentDetection.
Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetSegmentDetection.
For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5214,7 +5220,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the input image either as bytes or an S3 object.
\nYou pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.
For more information, see Analyzing an Image Loaded from a Local File System\n in the Amazon Rekognition Developer Guide.
\n You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.
The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.
\nIf you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.
\n \nFor Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "Provides the input image either as bytes or an S3 object.
\nYou pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.
For more information, see Analyzing an Image Loaded from a Local File System\n in the Amazon Rekognition Developer Guide.
\n You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.
The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.
\nIf you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.
\nFor Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.
" } }, "com.amazonaws.rekognition#ImageBlob": { @@ -5314,7 +5320,7 @@ } ], "traits": { - "smithy.api#documentation": "Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage operations.
\n \nFor more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not\n returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model\n version from the value of FaceModelVersion in the response from\n IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want\n to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. By default, IndexFaces chooses the quality bar that's used to filter\n faces. You can also explicitly choose the quality bar. Use QualityFilter, to set\n the quality bar by specifying LOW, MEDIUM, or HIGH. If\n you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't indexed\n for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for all\n detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide the same\n image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage operations.
\nFor more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not\n returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model\n version from the value of FaceModelVersion in the response from\n IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want\n to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. By default, IndexFaces chooses the quality bar that's used to filter\n faces. You can also explicitly choose the quality bar. Use QualityFilter, to set\n the quality bar by specifying LOW, MEDIUM, or HIGH. If\n you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't indexed\n for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for all\n detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide the same\n image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
Details about the detected label.
" } + }, + "StartTimestampMillis": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "The time in milliseconds defining the start of the timeline segment containing a continuously detected label.
" + } + }, + "EndTimestampMillis": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "The time in milliseconds defining the end of the timeline segment containing a continuously detected label.
" + } + }, + "DurationMillis": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "The time duration of a segment in milliseconds, I.e. time elapsed from StartTimestampMillis to EndTimestampMillis.
" + } } }, "traits": { "smithy.api#documentation": "Information about a label detected in a video analysis request and the time the label was detected in the video.
" } }, + "com.amazonaws.rekognition#LabelDetectionAggregateBy": { + "type": "enum", + "members": { + "TIMESTAMPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMPS" + } + }, + "SEGMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEGMENTS" + } + } + } + }, + "com.amazonaws.rekognition#LabelDetectionFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#LabelDetectionFeatureName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.rekognition#LabelDetectionFeatureName": { + "type": "enum", + "members": { + "GENERAL_LABELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERAL_LABELS" + } + } + } + }, + "com.amazonaws.rekognition#LabelDetectionSettings": { + "type": "structure", + "members": { + "GeneralLabels": { + "target": "com.amazonaws.rekognition#GeneralLabelsSettings" + } + }, + "traits": { + "smithy.api#documentation": "Contains the specified filters that should be applied to a list of returned GENERAL_LABELS.
" + } + }, "com.amazonaws.rekognition#LabelDetectionSortBy": { "type": "enum", "members": { @@ -6114,7 +6189,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns list of collection IDs in your account. If the result is truncated, the\n response also provides a NextToken that you can use in the subsequent request to\n fetch the next set of collection IDs.
For an example, see Listing collections in the Amazon Rekognition Developer\n Guide.
\nThis operation requires permissions to perform the\n rekognition:ListCollections action.
Returns list of collection IDs in your account. If the result is truncated, the\n response also provides a NextToken that you can use in the subsequent request to\n fetch the next set of collection IDs.
For an example, see Listing collections in the Amazon Rekognition Developer\n Guide.
\nThis operation requires permissions to perform the\n rekognition:ListCollections action.
\nLists the entries (images) within a dataset. An entry is a\nJSON Line that contains the information for a single image, including\nthe image location, assigned labels, and object location bounding boxes. For \nmore information, see Creating a manifest file.
\nJSON Lines in the response include information about non-terminal\n errors found in the dataset. \n Non terminal errors are reported in errors lists within each JSON Line. The\n same information is reported in the training and testing validation result manifests that\n Amazon Rekognition Custom Labels creates during model training.\n
You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.\n
\nThis operation requires permissions to perform the rekognition:ListDatasetEntries action.
\nLists the entries (images) within a dataset. An entry is a\nJSON Line that contains the information for a single image, including\nthe image location, assigned labels, and object location bounding boxes. For \nmore information, see Creating a manifest file.
\nJSON Lines in the response include information about non-terminal\n errors found in the dataset. \n Non terminal errors are reported in errors lists within each JSON Line. The\n same information is reported in the training and testing validation result manifests that\n Amazon Rekognition Custom Labels creates during model training.\n
You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.\n
\nThis operation requires permissions to perform the rekognition:ListDatasetEntries action.
Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see \n Labeling images.\n
\n\n Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images\n in the Amazon Rekognition Custom Labels Developer Guide.
", + "smithy.api#documentation": "Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see \n Labeling images.\n
\n\n Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images\n in the Amazon Rekognition Custom Labels Developer Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6996,7 +7071,7 @@ } }, "traits": { - "smithy.api#documentation": "Details and path tracking information for a single time a person's path is tracked in a video.\n Amazon Rekognition operations that track people's paths return an array of PersonDetection objects\n with elements for each time a person's path is tracked in a video.
For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "Details and path tracking information for a single time a person's path is tracked in a video.\n Amazon Rekognition operations that track people's paths return an array of PersonDetection objects\n with elements for each time a person's path is tracked in a video.
For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.
" } }, "com.amazonaws.rekognition#PersonDetections": { @@ -7078,7 +7153,7 @@ } }, "traits": { - "smithy.api#documentation": "The X and Y coordinates of a point on an image or video frame. The X and Y values are\n ratios of the overall image size or video resolution. For example, if an input image is\n 700x200 and the values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel\n coordinate on the image.
\n \nAn array of Point objects makes up a Polygon. A\n Polygon is returned by DetectText and by DetectCustomLabels\n Polygon represents a fine-grained polygon around a detected item. For more\n information, see Geometry in the Amazon Rekognition Developer Guide.
The X and Y coordinates of a point on an image or video frame. The X and Y values are\n ratios of the overall image size or video resolution. For example, if an input image is\n 700x200 and the values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel\n coordinate on the image.
\nAn array of Point objects makes up a Polygon. A\n Polygon is returned by DetectText and by DetectCustomLabels\n Polygon represents a fine-grained polygon around a detected item. For more\n information, see Geometry in the Amazon Rekognition Developer Guide.
Describes a project policy in the response from ListProjectPolicies.
\n\n" + "smithy.api#documentation": "
Describes a project policy in the response from ListProjectPolicies.
\n" } }, "com.amazonaws.rekognition#ProjectPolicyDocument": { @@ -7707,7 +7782,7 @@ } ], "traits": { - "smithy.api#documentation": "
Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.
\n \n \nFor more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\n \nThe response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.
To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.
\n \nYou copy a model version by calling CopyProjectVersion.
" + "smithy.api#documentation": "Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.
\nFor more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nThe response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.
To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.
\nYou copy a model version by calling CopyProjectVersion.
" } }, "com.amazonaws.rekognition#PutProjectPolicyRequest": { @@ -7886,7 +7961,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns an array of celebrities recognized in the input image. For more\n information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.
\n\n RecognizeCelebrities returns the 64 largest faces in the image. It lists\n the recognized celebrities in the CelebrityFaces array and any unrecognized faces\n in the UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.
For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.
Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n \nFor an example, see Recognizing celebrities in an image in the Amazon Rekognition\n Developer Guide.
\nThis operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.
Returns an array of celebrities recognized in the input image. For more\n information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.
\n\n RecognizeCelebrities returns the 64 largest faces in the image. It lists\n the recognized celebrities in the CelebrityFaces array and any unrecognized faces\n in the UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.
For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.
Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\nFor an example, see Recognizing celebrities in an image in the Amazon Rekognition\n Developer Guide.
\nThis operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.
Provides the S3 bucket name and object name.
\nThe region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.
\n \nFor Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "Provides the S3 bucket name and object name.
\nThe region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.
\nFor Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.
" } }, "com.amazonaws.rekognition#S3ObjectName": { @@ -9589,7 +9655,7 @@ } ], "traits": { - "smithy.api#documentation": "For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.
\nYou can also search faces without indexing faces by using the\n SearchFacesByImage operation.
The operation response returns an array of faces that match, ordered by similarity\n score with the highest similarity first. More specifically, it is an array of metadata for\n each face match that is found. Along with the metadata, the response also includes a\n confidence value for each face match, indicating the confidence that the\n specific face matches the input face.
For an example, see Searching for a face using its face ID in the Amazon Rekognition\n Developer Guide.
\nThis operation requires permissions to perform the rekognition:SearchFaces\n action.
For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.
\nYou can also search faces without indexing faces by using the\n SearchFacesByImage operation.
The operation response returns an array of faces that match, ordered by similarity\n score with the highest similarity first. More specifically, it is an array of metadata for\n each face match that is found. Along with the metadata, the response also includes a\n confidence value for each face match, indicating the confidence that the\n specific face matches the input face.
For an example, see Searching for a face using its face ID in the Amazon Rekognition\n Developer Guide.
\nThis operation requires permissions to perform the rekognition:SearchFaces\n action.
For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.
\nTo search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls\n to the SearchFaces operation.
\n You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n The response returns an array of faces that match, ordered by similarity score with\n the highest similarity first. More specifically, it is an array of metadata for each face\n match found. Along with the metadata, the response also includes a similarity\n indicating how similar the face is to the input face. In the response, the operation also\n returns the bounding box (and a confidence level that the bounding box contains a face) of the\n face that Amazon Rekognition used for the input image.
If no faces are detected in the input image, SearchFacesByImage returns an\n InvalidParameterException error.
For an example, Searching for a Face Using an Image in the Amazon Rekognition\n Developer Guide.
\nThe QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar for filtering by specifying\n LOW, MEDIUM, or HIGH. If you do not want to filter\n detected faces, specify NONE. The default value is NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nThis operation requires permissions to perform the\n rekognition:SearchFacesByImage action.
For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.
\nTo search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls\n to the SearchFaces operation.
\n You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n The response returns an array of faces that match, ordered by similarity score with\n the highest similarity first. More specifically, it is an array of metadata for each face\n match found. Along with the metadata, the response also includes a similarity\n indicating how similar the face is to the input face. In the response, the operation also\n returns the bounding box (and a confidence level that the bounding box contains a face) of the\n face that Amazon Rekognition used for the input image.
If no faces are detected in the input image, SearchFacesByImage returns an\n InvalidParameterException error.
For an example, Searching for a Face Using an Image in the Amazon Rekognition\n Developer Guide.
\nThe QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar for filtering by specifying\n LOW, MEDIUM, or HIGH. If you do not want to filter\n detected faces, specify NONE. The default value is NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nThis operation requires permissions to perform the\n rekognition:SearchFacesByImage action.
The size of the collection exceeds the allowed limit. For more information,\n see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
", + "smithy.api#documentation": "\nThe size of the collection exceeds the allowed limit. For more information,\n see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
", "smithy.api#error": "client" } }, @@ -10004,7 +10070,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts asynchronous recognition of celebrities in a stored video.
\nAmazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartCelebrityRecognition\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier\n (JobId) from the initial call to StartCelebrityRecognition.
For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.
", + "smithy.api#documentation": "Starts asynchronous recognition of celebrities in a stored video.
\nAmazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartCelebrityRecognition\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier\n (JobId) from the initial call to StartCelebrityRecognition.
For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.
", "smithy.api#idempotent": {} } }, @@ -10087,7 +10153,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.
\nAmazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartContentModeration\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.
For more information, see Moderating content in the Amazon Rekognition Developer Guide.
", + "smithy.api#documentation": "Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.
\nAmazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartContentModeration\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.
For more information, see Moderating content in the Amazon Rekognition Developer Guide.
", "smithy.api#idempotent": {} } }, @@ -10176,7 +10242,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts asynchronous detection of faces in a stored video.
\nAmazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.\n Use Video to specify the bucket name and the filename of the video.\n StartFaceDetection returns a job identifier (JobId) that you\n use to get the results of the operation.\n When face detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the face detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier\n (JobId) from the initial call to StartFaceDetection.
For more information, see Detecting faces in a stored video in the \n Amazon Rekognition Developer Guide.
", + "smithy.api#documentation": "Starts asynchronous detection of faces in a stored video.
\nAmazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.\n Use Video to specify the bucket name and the filename of the video.\n StartFaceDetection returns a job identifier (JobId) that you\n use to get the results of the operation.\n When face detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the face detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier\n (JobId) from the initial call to StartFaceDetection.
For more information, see Detecting faces in a stored video in the \n Amazon Rekognition Developer Guide.
", "smithy.api#idempotent": {} } }, @@ -10364,7 +10430,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts asynchronous detection of labels in a stored video.
\nAmazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.\n This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities\n like a person getting out of a car or a person skiing.
\n\nThe video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartLabelDetection returns a job identifier (JobId) which you use to get the\n results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
To get the results of the label detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier\n (JobId) from the initial call to StartLabelDetection.
Starts asynchronous detection of labels in a stored video.
\nAmazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.\n This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities\n like a person getting out of a car or a person skiing.
\nThe video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartLabelDetection returns a job identifier (JobId) which you use to get the\n results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
To get the results of the label detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier\n (JobId) from the initial call to StartLabelDetection.
\n Optional Parameters\n
\n\n StartLabelDetection has the GENERAL_LABELS Feature applied by\n default. This feature allows you to provide filtering criteria to the Settings\n parameter. You can filter with sets of individual labels or with label categories. You can\n specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive\n filters. For more information on filtering, see Detecting labels in a\n video.
You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 50.
Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence\n represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level\n lower than this specified value.
\nIf you don't specify MinConfidence, the operation returns labels with confidence\n values greater than or equal to 50 percent.
Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence\n represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level\n lower than this specified value.
\nIf you don't specify MinConfidence, the operation returns labels and\n bounding boxes (if detected) with confidence values greater than or equal to 50\n percent.
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.
The features to return after video analysis. You can specify that GENERAL_LABELS are returned.
" + } + }, + "Settings": { + "target": "com.amazonaws.rekognition#LabelDetectionSettings", + "traits": { + "smithy.api#documentation": "The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. \n Settings can include filters for GENERAL_LABELS.
" + } } } }, @@ -10533,7 +10611,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.
\nOnce the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.
\nYou are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.
\nFor more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.
\n \nThis operation requires permissions to perform the \n rekognition:StartProjectVersion action.
Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.
\nOnce the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.
\nYou are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.
\nFor more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.
\nThis operation requires permissions to perform the \n rekognition:StartProjectVersion action.
The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing.
\n \nFor information about the number \n of transactions per second (TPS) that an inference unit can support, see \n Running a trained Amazon Rekognition Custom Labels model in the \n Amazon Rekognition Custom Labels Guide.\n
\nUse a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n
", + "smithy.api#documentation": "The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing.
\nFor information about the number \n of transactions per second (TPS) that an inference unit can support, see \n Running a trained Amazon Rekognition Custom Labels model in the \n Amazon Rekognition Custom Labels Guide.\n
\nUse a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n
", "smithy.api#required": {} } }, @@ -10610,7 +10688,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts asynchronous detection of segment detection in a stored video.
\nAmazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and \n the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get \n the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in NotificationChannel.
You can use the Filters (StartSegmentDetectionFilters) \n input parameter to specify the minimum detection confidence returned in the response. \n Within Filters, use ShotFilter (StartShotDetectionFilter)\n to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter)\n to filter technical cues.
To get the results of the segment detection operation, first check that the status value published to the Amazon SNS \n topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) \n from the initial call to StartSegmentDetection.
For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.
", + "smithy.api#documentation": "Starts asynchronous detection of segment detection in a stored video.
\nAmazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and \n the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get \n the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in NotificationChannel.
You can use the Filters (StartSegmentDetectionFilters) \n input parameter to specify the minimum detection confidence returned in the response. \n Within Filters, use ShotFilter (StartShotDetectionFilter)\n to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter)\n to filter technical cues.
To get the results of the segment detection operation, first check that the status value published to the Amazon SNS \n topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) \n from the initial call to StartSegmentDetection.
For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.
", "smithy.api#idempotent": {} } }, @@ -10733,7 +10811,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor.\n To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to\n CreateStreamProcessor.
If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.
Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor.\n To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to\n CreateStreamProcessor.
If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.
\n Specifies the starting point in the Kinesis stream to start processing. \n You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds.\n For more information about fragment numbers, see Fragment. \n
\nThis is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" + "smithy.api#documentation": "\n Specifies the starting point in the Kinesis stream to start processing. \n You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds.\n For more information about fragment numbers, see Fragment. \n
\nThis is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" } }, "StopSelector": { "target": "com.amazonaws.rekognition#StreamProcessingStopSelector", "traits": { - "smithy.api#documentation": "\n Specifies when to stop processing the stream. You can specify a \n maximum amount of time to process the video. \n
\nThis is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" + "smithy.api#documentation": "\n Specifies when to stop processing the stream. You can specify a \n maximum amount of time to process the video. \n
\nThis is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" } } } @@ -11123,7 +11201,7 @@ } }, "traits": { - "smithy.api#documentation": "The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
\nAmazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition\n detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,\n one for a person at second 2 and one for a pet at second 4.
\nAmazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.
" + "smithy.api#documentation": "The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
\nAmazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition\n detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,\n one for a person at second 2 and one for a pet at second 4.
\nAmazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.
" } }, "com.amazonaws.rekognition#StreamProcessorOutput": { @@ -11546,7 +11624,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about a word or line of text detected by DetectText.
\nThe DetectedText field contains the text that Amazon Rekognition detected in the\n image.
Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.
For more information, see Detecting text in the Amazon Rekognition Developer\n Guide.
" + "smithy.api#documentation": "Information about a word or line of text detected by DetectText.
\nThe DetectedText field contains the text that Amazon Rekognition detected in the\n image.
Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.
For more information, see Detecting text in the Amazon Rekognition Developer\n Guide.
" } }, "com.amazonaws.rekognition#TextDetectionList": { @@ -11801,7 +11879,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the\n information for a single image, including\n the image location, assigned labels, and object location bounding boxes. For more information, \n see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n
\n \n \n \nIf the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.
You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.
\n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.
To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.
Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n
This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.
Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the\n information for a single image, including\n the image location, assigned labels, and object location bounding boxes. For more information, \n see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n
\nIf the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.
You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.
\n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.
To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.
Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n
This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.
Contains the Amazon S3 bucket location of the validation data for a model training job.
\nThe validation data includes error information for individual JSON Lines in the dataset.\n For more information, see Debugging a Failed Model Training in the\n Amazon Rekognition Custom Labels Developer Guide.
\n \nYou get the ValidationData object for the training dataset (TrainingDataResult)\n and the test dataset (TestingDataResult) by calling DescribeProjectVersions.
The assets array contains a single Asset object. \n The GroundTruthManifest field of the Asset object contains the S3 bucket location of\n the validation data. \n
" + "smithy.api#documentation": "Contains the Amazon S3 bucket location of the validation data for a model training job.
\nThe validation data includes error information for individual JSON Lines in the dataset.\n For more information, see Debugging a Failed Model Training in the\n Amazon Rekognition Custom Labels Developer Guide.
\nYou get the ValidationData object for the training dataset (TrainingDataResult)\n and the test dataset (TestingDataResult) by calling DescribeProjectVersions.
The assets array contains a single Asset object. \n The GroundTruthManifest field of the Asset object contains the S3 bucket location of\n the validation data. \n
" } }, "com.amazonaws.rekognition#VersionName": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker-metrics.json b/codegen/sdk-codegen/aws-models/sagemaker-metrics.json new file mode 100644 index 00000000000..02a78ddc1ba --- /dev/null +++ b/codegen/sdk-codegen/aws-models/sagemaker-metrics.json @@ -0,0 +1,852 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.sagemakermetrics#BatchPutMetrics": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsRequest" + }, + "output": { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsResponse" + }, + "traits": { + "smithy.api#documentation": "Used to ingest training metrics into SageMaker which can be visualized in SageMaker Studio and\n retrieved with the GetMetrics API.\n
The error code of an error that occured when attempting to put metrics.
\n\n METRIC_LIMIT_EXCEEDED - The max amount of metrics per resource has been exceeded.
\n INTERNAL_ERROR - An internal error occured.
\n VALIDATION_ERROR - The metric data failed validation.
\n CONFLICT_ERROR - Multiple requests attempted to modify the same data simultaneously.
An index that corresponds to the metric in the request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An error that occured when putting the metric data.
" + } + }, + "com.amazonaws.sagemakermetrics#BatchPutMetricsErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsError" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemakermetrics#BatchPutMetricsRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemakermetrics#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of Trial Component to associate the metrics with.
", + "smithy.api#required": {} + } + }, + "MetricData": { + "target": "com.amazonaws.sagemakermetrics#RawMetricDataList", + "traits": { + "smithy.api#documentation": "A list of raw metric values to put.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sagemakermetrics#BatchPutMetricsResponse": { + "type": "structure", + "members": { + "Errors": { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsErrorList", + "traits": { + "smithy.api#documentation": "Any errors that occur when inserting metric data will appear in this.
" + } + } + } + }, + "com.amazonaws.sagemakermetrics#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.sagemakermetrics#ExperimentEntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 120 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}$" + } + }, + "com.amazonaws.sagemakermetrics#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.sagemakermetrics#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemakermetrics#PutMetricsErrorCode": { + "type": "enum", + "members": { + "METRIC_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METRIC_LIMIT_EXCEEDED" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_ERROR" + } + }, + "CONFLICT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT_ERROR" + } + } + } + }, + "com.amazonaws.sagemakermetrics#RawMetricData": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemakermetrics#MetricName", + "traits": { + "smithy.api#documentation": "The name of the metric.
", + "smithy.api#required": {} + } + }, + "Timestamp": { + "target": "com.amazonaws.sagemakermetrics#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the metric was recorded.
", + "smithy.api#required": {} + } + }, + "Step": { + "target": "com.amazonaws.sagemakermetrics#Step", + "traits": { + "smithy.api#documentation": "Metric step (aka Epoch).\n
" + } + }, + "Value": { + "target": "com.amazonaws.sagemakermetrics#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The metric value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The raw metric data to associate with the resource.
" + } + }, + "com.amazonaws.sagemakermetrics#RawMetricDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemakermetrics#RawMetricData" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemakermetrics#SageMakerMetricsService": { + "type": "service", + "version": "2022-09-30", + "operations": [ + { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetrics" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SageMaker Metrics", + "arnNamespace": "sagemaker", + "cloudFormationName": "SageMakerMetrics", + "cloudTrailEventSource": "sagemakermetrics.amazonaws.com", + "endpointPrefix": "metrics.sagemaker" + }, + "aws.auth#sigv4": { + "name": "sagemaker" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Contains all data plane API operations and data types for Amazon SageMaker Metrics. \n Use these APIs to put and retrieve (get) features related to your training run.
\n\n BatchPutMetrics\n
\nInspect all of the elements that WAF has parsed and extracted from the web request\n component that you've identified in your FieldToMatch specifications.
\nThis is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"All\": {}\n
Inspect all of the elements that WAF has parsed and extracted from the web request\n component that you've identified in your FieldToMatch specifications.
\nThis is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"All\": {}\n
Inspect all query arguments of the web request.
\nThis is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"AllQueryArguments\": {}\n
Inspect all query arguments of the web request.
\nThis is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"AllQueryArguments\": {}\n
Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nFor Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.
When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
" + "smithy.api#documentation": "Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nFor Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.
When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
" } }, "com.amazonaws.wafv2#AssociateWebACLRequest": { @@ -2066,7 +2109,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
\n \nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
\nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
Specifies that WAF should run a CAPTCHA check against the request:
If the request includes a valid, unexpired CAPTCHA token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.
If the request doesn't include a valid, unexpired token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
\nWAF generates a response that it sends back to the client, which includes the following:
\nThe header x-amzn-waf-action with a value of captcha.
The HTTP status code 405 Method Not Allowed.
If the request contains an Accept header with a value of text/html, the response includes a CAPTCHA JavaScript page interstitial.
You can configure the expiration time \n in the CaptchaConfig \n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
This action option is available for rules. It isn't available for web ACL default actions.
" + "smithy.api#documentation": "Specifies that WAF should run a CAPTCHA check against the request:
If the request includes a valid, unexpired CAPTCHA token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.
If the request doesn't include a valid, unexpired token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
\nWAF generates a response that it sends back to the client, which includes the following:
\nThe header x-amzn-waf-action with a value of captcha.
The HTTP status code 405 Method Not Allowed.
If the request contains an Accept header with a value of text/html, the response includes a CAPTCHA JavaScript page interstitial.
You can configure the expiration time \n in the CaptchaConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
This action option is available for rules. It isn't available for web ACL default actions.
" } }, "com.amazonaws.wafv2#CaptchaConfig": { @@ -2243,7 +2286,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:
If the request includes a valid, unexpired challenge token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.
If the request doesn't include a valid, unexpired challenge token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
\nWAF then generates a challenge response that it sends back to the client, which includes the following:
\nThe header x-amzn-waf-action with a value of challenge.
The HTTP status code 202 Request Accepted.
If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script.
Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.
\nA challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.
\nAfter the client session successfully responds to \n the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.
\nYou can configure the expiration time \n in the ChallengeConfig \n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
This action option is available for rules. It isn't available for web ACL default actions.
" + "smithy.api#documentation": "Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:
If the request includes a valid, unexpired challenge token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.
If the request doesn't include a valid, unexpired challenge token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
\nWAF then generates a challenge response that it sends back to the client, which includes the following:
\nThe header x-amzn-waf-action with a value of challenge.
The HTTP status code 202 Request Accepted.
If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script.
Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.
\nA challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.
\nAfter the client session successfully responds to \n the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.
\nYou can configure the expiration time \n in the ChallengeConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
This action option is available for rules. It isn't available for web ACL default actions.
" } }, "com.amazonaws.wafv2#ChallengeConfig": { @@ -2503,7 +2546,7 @@ } }, "traits": { - "smithy.api#documentation": "Inspect the cookies in the web request. You can specify the parts of the cookies to\n inspect and you can narrow the set of cookies to inspect by including or excluding specific\n keys.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nExample JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n
Inspect the cookies in the web request. You can specify the parts of the cookies to\n inspect and you can narrow the set of cookies to inspect by including or excluding specific\n keys.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nExample JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": []\n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n
INVALID specification: \"Addresses\": [\"\"] INVALID
The web ACL capacity units (WCUs) required for this rule group.
\nWhen you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
", + "smithy.api#documentation": "The web ACL capacity units (WCUs) required for this rule group.
\nWhen you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
", "smithy.api#required": {} } }, @@ -4320,7 +4363,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" } } } @@ -4444,7 +4487,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" } }, "CaptchaConfig": { @@ -4462,7 +4505,7 @@ "TokenDomains": { "target": "com.amazonaws.wafv2#TokenDomains", "traits": { - "smithy.api#documentation": "Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
\nExample JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
\nExample JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n
Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
\n \nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
\nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nYou can specify the following fallback behaviors:
\n\n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule statement.
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
\nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nYou can specify the following fallback behaviors:
\n\n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule statement.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.
\nWAF only evaluates the first IP address found in the specified HTTP header.\n
" + "smithy.api#documentation": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.
\nWAF only evaluates the first IP address found in the specified HTTP header.\n
" } }, "com.amazonaws.wafv2#ForwardedIPHeaderName": { @@ -5693,12 +5736,12 @@ "ForwardedIPConfig": { "target": "com.amazonaws.wafv2#ForwardedIPConfig", "traits": { - "smithy.api#documentation": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nA rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
\nTo manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.
Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
\nWAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.
If you use the web request origin, the label formats are awswaf:clientip:geo:region: and awswaf:clientip:geo:country:.
If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region: and awswaf:forwardedip:geo:country:.
For additional details, see Geographic match rule statement in the WAF Developer Guide.
" + "smithy.api#documentation": "A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
\nTo manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.
Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
\nWAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.
If you use the web request origin, the label formats are awswaf:clientip:geo:region: and awswaf:clientip:geo:country:.
If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region: and awswaf:forwardedip:geo:country:.
For additional details, see Geographic match rule statement in the WAF Developer Guide.
" } }, "com.amazonaws.wafv2#GetIPSet": { @@ -5851,7 +5894,7 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", + "smithy.api#documentation": "The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", "smithy.api#required": {} } }, @@ -6362,7 +6405,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
\n \nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
\nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
Inspect all headers in the web request. You can specify the parts of the headers to\n inspect and you can narrow the set of headers to inspect by including or excluding specific\n keys.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nIf you want to inspect just the value of a single header, use the\n SingleHeader\n FieldToMatch setting instead.
Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n
Inspect all headers in the web request. You can specify the parts of the headers to\n inspect and you can narrow the set of headers to inspect by including or excluding specific\n keys.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nIf you want to inspect just the value of a single header, use the\n SingleHeader\n FieldToMatch setting instead.
Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": []\n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n
INVALID specification: \"Addresses\": [\"\"] INVALID
The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nYou can specify the following fallback behaviors:
\n\n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule statement.
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
\nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nYou can specify the following fallback behaviors:
\n\n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule statement.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.
" + "smithy.api#documentation": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.
" } }, "com.amazonaws.wafv2#IPSetReferenceStatement": { @@ -6701,12 +6744,12 @@ "IPSetForwardedIPConfig": { "target": "com.amazonaws.wafv2#IPSetForwardedIPConfig", "traits": { - "smithy.api#documentation": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nA rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
\nEach IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" + "smithy.api#documentation": "A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
\nEach IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" } }, "com.amazonaws.wafv2#IPSetSummaries": { @@ -6819,7 +6862,7 @@ } }, "traits": { - "smithy.api#documentation": "Inspect the body of the web request as JSON. The body immediately follows the request\n headers.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nUse the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you indicate.\n
\nExample JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n }\n
Inspect the body of the web request as JSON. The body immediately follows the request\n headers.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nUse the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you indicate.\n
\nExample JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n }\n
Defines an association between logging destinations and a web ACL resource, for logging\n from WAF. As part of the association, you can specify parts of the standard logging\n fields to keep out of the logs and you can specify filters so that you log only a subset of\n the logging records.
\nYou can define one logging destination per web ACL.
\nYou can access information about the traffic that WAF inspects using the following\n steps:
\nCreate your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nAssociate your logging destination to your web ACL using a\n PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
" + "smithy.api#documentation": "Defines an association between logging destinations and a web ACL resource, for logging\n from WAF. As part of the association, you can specify parts of the standard logging\n fields to keep out of the logs and you can specify filters so that you log only a subset of\n the logging records.
\nYou can define one logging destination per web ACL.
\nYou can access information about the traffic that WAF inspects using the following\n steps:
\nCreate your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.
\nThe name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.
For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.
\nAssociate your logging destination to your web ACL using a\n PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
" } }, "com.amazonaws.wafv2#LoggingConfigurations": { @@ -7874,7 +7917,7 @@ } }, "traits": { - "smithy.api#documentation": "Additional information that's used by a managed rule group. Many managed rule groups don't require this.
\nUse the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.
For example specifications, see the examples section of CreateWebACL.
" + "smithy.api#documentation": "Additional information that's used by a managed rule group. Many managed rule groups don't require this.
\nUse the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.
For example specifications, see the examples section of CreateWebACL.
" } }, "com.amazonaws.wafv2#ManagedRuleGroupConfigs": { @@ -7937,7 +7980,7 @@ } }, "traits": { - "smithy.api#documentation": "A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", + "smithy.api#documentation": "The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", "smithy.api#required": {} } }, @@ -8050,7 +8093,7 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
" + "smithy.api#documentation": "The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
" } }, "Id": { @@ -8100,7 +8143,7 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The web ACL capacity units (WCUs) required for this rule group.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
" + "smithy.api#documentation": "The web ACL capacity units (WCUs) required for this rule group.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
" } }, "ForecastedLifetime": { @@ -8180,7 +8223,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Inspect the HTTP method of the web request. The method indicates the type of operation\n that the request is asking the origin to perform.
\nThis is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"Method\": {}\n
Inspect the HTTP method of the web request. The method indicates the type of operation\n that the request is asking the origin to perform.
\nThis is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"Method\": {}\n
Specifies that WAF should do nothing. This is used for the\n OverrideAction setting on a Rule when the rule uses a\n rule group reference statement.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
\nJSON specification: \"None\": {}\n
Specifies that WAF should do nothing. This is used for the\n OverrideAction setting on a Rule when the rule uses a\n rule group reference statement.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
\nJSON specification: \"None\": {}\n
Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.
\nYou can define one logging destination per web ACL.
\nYou can access information about the traffic that WAF inspects using the following\n steps:
\nCreate your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nAssociate your logging destination to your web ACL using a\n PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nThis operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.
\nEnables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.
\nYou can define one logging destination per web ACL.
\nYou can access information about the traffic that WAF inspects using the following\n steps:
\nCreate your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.
\nThe name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.
For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.
\nAssociate your logging destination to your web ACL using a\n PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nThis operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.
\nDefines the versions of your managed rule set that you are offering to the customers.\n Customers see your offerings as managed rule groups with versioning.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your\n managed rule set is the name the customer sees for the corresponding managed rule group.\n Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group\n specification for each version. For each managed rule set, you must specify a version that\n you recommend using.
\nTo initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
" + "smithy.api#documentation": "Defines the versions of your managed rule set that you are offering to the customers.\n Customers see your offerings as managed rule groups with versioning.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your\n managed rule set is the name the customer sees for the corresponding managed rule group.\n Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group\n specification for each version. For each managed rule set, you must specify a version that\n you recommend using.
\nTo initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
" } }, "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest": { @@ -8935,7 +8978,7 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", + "smithy.api#documentation": "The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", "smithy.api#required": {} } }, @@ -9024,7 +9067,7 @@ "Policy": { "target": "com.amazonaws.wafv2#PolicyString", "traits": { - "smithy.api#documentation": "The policy to attach to the specified rule group.
\n \nThe policy specifications must conform to the following:
\nThe policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
\nThe policy must include specifications for Effect, Action, and Principal.
\n Effect must specify Allow.
\n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource parameter.
For more information, see IAM Policies.
", + "smithy.api#documentation": "The policy to attach to the specified rule group.
\nThe policy specifications must conform to the following:
\nThe policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
\nThe policy must include specifications for Effect, Action, and Principal.
\n Effect must specify Allow.
\n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource parameter.
For more information, see IAM Policies.
", "smithy.api#required": {} } } @@ -9038,7 +9081,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Inspect the query string of the web request. This is the part of a URL that appears\n after a ? character, if any.
This is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"QueryString\": {}\n
Inspect the query string of the web request. This is the part of a URL that appears\n after a ? character, if any.
This is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"QueryString\": {}\n
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis is required if AggregateKeyType is set to\n FORWARDED_IP.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis is required if AggregateKeyType is set to\n FORWARDED_IP.
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
\nWAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
\nWhen the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.
\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
\nAn IP match statement with an IP set that specified the address 192.0.2.44.
\nA string match statement that searches in the User-Agent header for the string BadBot.
\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.
\nYou cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
\nWAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
\nWhen the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.
\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
\nAn IP match statement with an IP set that specified the address 192.0.2.44.
\nA string match statement that searches in the User-Agent header for the string BadBot.
\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.
\nYou cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
\nEach regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" + "smithy.api#documentation": "A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
\nEach regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" } }, "com.amazonaws.wafv2#RegexPatternSetSummaries": { @@ -9452,7 +9495,7 @@ "Action": { "target": "com.amazonaws.wafv2#RuleAction", "traits": { - "smithy.api#documentation": "The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
\nThis is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
You must specify either this Action setting or the rule OverrideAction setting, but not both:
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
\nIf the rule statement references a rule group, use the override action setting and not this action setting.
\nThe action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
\nThis is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
You must specify either this Action setting or the rule OverrideAction setting, but not both:
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
\nIf the rule statement references a rule group, use the override action setting and not this action setting.
\nThe web ACL capacity units (WCUs) required for this rule group.
\nWhen you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
", + "smithy.api#documentation": "The web ACL capacity units (WCUs) required for this rule group.
\nWhen you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
", "smithy.api#required": {} } }, @@ -9617,13 +9660,13 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
\nThe syntax for the label namespace prefix for your rule groups is the following:
\n\n awswaf:\n
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
\nThe syntax for the label namespace prefix for your rule groups is the following:
\n\n awswaf:\n
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" } }, "AvailableLabels": { @@ -9906,7 +9949,7 @@ } }, "traits": { - "smithy.api#documentation": "Inspect one of the headers in the web request, identified by name, for example,\n User-Agent or Referer. The name isn't case sensitive.
You can filter and inspect all headers with the FieldToMatch setting\n Headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nExample JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n
Inspect one of the headers in the web request, identified by name, for example,\n User-Agent or Referer. The name isn't case sensitive.
You can filter and inspect all headers with the FieldToMatch setting\n Headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nExample JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n
Inspect one query argument in the web request, identified by name, for example\n UserName or SalesRegion. The name isn't case\n sensitive.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nExample JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n
Inspect one query argument in the web request, identified by name, for example\n UserName or SalesRegion. The name isn't case\n sensitive.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nExample JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
\nIf you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.
\nIf you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
\nIf you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.
\nIf you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
The sensitivity that you want WAF to use to inspect for SQL injection attacks.
\n\n HIGH detects more attacks, but might generate more false positives, \n especially if your web requests frequently contain unusual strings. \n For information about identifying and mitigating false positives, see \n Testing and tuning in the \n WAF Developer Guide.
\n LOW is generally a better choice for resources that already have other \n protections against SQL injection attacks or that have a low tolerance for false positives.
Default: LOW\n
The sensitivity that you want WAF to use to inspect for SQL injection attacks.
\n\n HIGH detects more attacks, but might generate more false positives, \n especially if your web requests frequently contain unusual strings. \n For information about identifying and mitigating false positives, see \n Testing and tuning in the \n WAF Developer Guide.
\n LOW is generally a better choice for resources that already have other \n protections against SQL injection attacks or that have a low tolerance for false positives.
Default: LOW\n
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
\nIf you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.
\nIf you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
\nIf you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.
\nIf you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
\nTo manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.
Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
\nWAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.
If you use the web request origin, the label formats are awswaf:clientip:geo:region: and awswaf:clientip:geo:country:.
If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region: and awswaf:forwardedip:geo:country:.
For additional details, see Geographic match rule statement in the WAF Developer Guide.
" + "smithy.api#documentation": "A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
\nTo manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.
Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
\nWAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.
If you use the web request origin, the label formats are awswaf:clientip:geo:region: and awswaf:clientip:geo:country:.
If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region: and awswaf:forwardedip:geo:country:.
For additional details, see Geographic match rule statement in the WAF Developer Guide.
" } }, "RuleGroupReferenceStatement": { @@ -10044,19 +10087,19 @@ "IPSetReferenceStatement": { "target": "com.amazonaws.wafv2#IPSetReferenceStatement", "traits": { - "smithy.api#documentation": "A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
\nEach IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" + "smithy.api#documentation": "A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
\nEach IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" } }, "RegexPatternSetReferenceStatement": { "target": "com.amazonaws.wafv2#RegexPatternSetReferenceStatement", "traits": { - "smithy.api#documentation": "A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
\nEach regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" + "smithy.api#documentation": "A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
\nEach regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" } }, "RateBasedStatement": { "target": "com.amazonaws.wafv2#RateBasedStatement", "traits": { - "smithy.api#documentation": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
\nWAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
\nWhen the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.
\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
\nAn IP match statement with an IP set that specified the address 192.0.2.44.
\nA string match statement that searches in the User-Agent header for the string BadBot.
\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.
\nYou cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
\nWAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
\nWhen the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.
\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
\nAn IP match statement with an IP set that specified the address 192.0.2.44.
\nA string match statement that searches in the User-Agent header for the string BadBot.
\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.
\nYou cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
Updates the specified IPSet.
\nThis operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.
\nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
" + "smithy.api#documentation": "Updates the specified IPSet.
\nThis operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.
\nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
" } }, "com.amazonaws.wafv2#UpdateIPSetRequest": { @@ -10611,7 +10654,7 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": []\n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n
INVALID specification: \"Addresses\": [\"\"] INVALID
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", + "smithy.api#documentation": "The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", "smithy.api#required": {} } }, @@ -10766,7 +10809,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified RegexPatternSet.
\nThis operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.
\nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
" + "smithy.api#documentation": "Updates the specified RegexPatternSet.
\nThis operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.
\nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
" } }, "com.amazonaws.wafv2#UpdateRegexPatternSetRequest": { @@ -10867,7 +10910,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified RuleGroup.
\nThis operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.
\nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
\nA rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
" + "smithy.api#documentation": "Updates the specified RuleGroup.
\nThis operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.
\nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
\nA rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
" } }, "com.amazonaws.wafv2#UpdateRuleGroupRequest": { @@ -10923,7 +10966,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" } } } @@ -10986,7 +11029,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.
\n \nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
\nThis operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.
\nA web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.
" + "smithy.api#documentation": "Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.
\nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
\nThis operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.
\nA web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.
" } }, "com.amazonaws.wafv2#UpdateWebACLRequest": { @@ -11049,7 +11092,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" } }, "CaptchaConfig": { @@ -11067,7 +11110,7 @@ "TokenDomains": { "target": "com.amazonaws.wafv2#TokenDomains", "traits": { - "smithy.api#documentation": "Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
\nExample JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
\nExample JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n
Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.
Inspect the path component of the URI of the web request. This is the part of the web\n request that identifies a resource. For example, /images/daily-ad.jpg.
This is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"UriPath\": {}\n
Inspect the path component of the URI of the web request. This is the part of the web\n request that identifies a resource. For example, /images/daily-ad.jpg.
This is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"UriPath\": {}\n
The operation failed because the specified policy isn't in the proper format.
\n \nThe policy specifications must conform to the following:
\nThe policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
\nThe policy must include specifications for Effect, Action, and Principal.
\n Effect must specify Allow.
\n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource parameter.
For more information, see IAM Policies.
", + "smithy.api#documentation": "The operation failed because the specified policy isn't in the proper format.
\nThe policy specifications must conform to the following:
\nThe policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
\nThe policy must include specifications for Effect, Action, and Principal.
\n Effect must specify Allow.
\n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource parameter.
For more information, see IAM Policies.
", "smithy.api#error": "client" } }, @@ -11498,13 +11541,13 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
\nThe syntax for the label namespace prefix for a web ACL is the following:
\n\n awswaf:\n
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
\nThe syntax for the label namespace prefix for a web ACL is the following:
\n\n awswaf:\n
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" } }, "CaptchaConfig": {