The response object sent when a backend is created.
", "refs" : { } }, + "BackendAuthAppleProviderConfig" : { + "base" : "Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
", + "refs" : { + "SocialProviderSettings$SignInWithApple" : null + } + }, "BackendAuthRespObj" : { "base" : "The response object for this operation.
", "refs" : { } @@ -134,9 +140,9 @@ } }, "CreateBackendAuthMFAConfig" : { - "base" : "Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.
", + "base" : "Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
", "refs" : { - "CreateBackendAuthUserPoolConfig$Mfa" : "Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.
" + "CreateBackendAuthUserPoolConfig$Mfa" : "Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
" } }, "CreateBackendAuthOAuthConfig" : { @@ -199,7 +205,7 @@ "DeliveryMethod" : { "base" : null, "refs" : { - "CreateBackendAuthForgotPasswordConfig$DeliveryMethod" : "Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
", + "CreateBackendAuthForgotPasswordConfig$DeliveryMethod" : "Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
", "UpdateBackendAuthForgotPasswordConfig$DeliveryMethod" : "Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
" } }, @@ -272,7 +278,7 @@ "MFAMode" : { "base" : null, "refs" : { - "CreateBackendAuthMFAConfig$MFAMode" : "Describes whether MFA should be [ON, OFF, OPTIONAL] for authentication in your Amplify project.
", + "CreateBackendAuthMFAConfig$MFAMode" : "Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
", "UpdateBackendAuthMFAConfig$MFAMode" : "The MFA mode for the backend of your Amplify project.
" } }, @@ -380,7 +386,7 @@ "UpdateBackendAuthMFAConfig" : { "base" : "Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.
", "refs" : { - "UpdateBackendAuthUserPoolConfig$Mfa" : "Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.
" + "UpdateBackendAuthUserPoolConfig$Mfa" : "Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
" } }, "UpdateBackendAuthOAuthConfig" : { @@ -445,7 +451,7 @@ "CreateBackendAuthIdentityPoolConfig$UnauthenticatedLogin" : "Set to true or false based on whether you want to enable guest authorization to your Amplify app.
", "DeleteTokenRespObj$IsSuccess" : "Indicates whether the request succeeded or failed.
", "RemoveAllBackendsReqObj$CleanAmplifyApp" : "Cleans up the Amplify Console app if this value is set to true.
", - "UpdateBackendAuthIdentityPoolConfig$UnauthenticatedLogin" : "A boolean value which can be set to allow or disallow guest-level authorization into your Amplify app.
" + "UpdateBackendAuthIdentityPoolConfig$UnauthenticatedLogin" : "A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.
" } }, "__double" : { @@ -504,10 +510,10 @@ "base" : null, "refs" : { "CreateBackendAuthOAuthConfig$RedirectSignInURIs" : "The redirected URI for signing in to your Amplify app.
", - "CreateBackendAuthOAuthConfig$RedirectSignOutURIs" : "Redirect URLs used by OAuth when a user signs out of an Amplify app.
", + "CreateBackendAuthOAuthConfig$RedirectSignOutURIs" : "Redirect URLs that OAuth uses when a user signs out of an Amplify app.
", "GetBackendRespObj$BackendEnvironmentList" : "A list of backend environments in an array.
", - "UpdateBackendAuthOAuthConfig$RedirectSignInURIs" : "Redirect URLs used by OAuth when a user signs in to an Amplify app.
", - "UpdateBackendAuthOAuthConfig$RedirectSignOutURIs" : "Redirect URLs used by OAuth when a user signs out of an Amplify app.
" + "UpdateBackendAuthOAuthConfig$RedirectSignInURIs" : "Redirect URLs that OAuth uses when a user signs in to an Amplify app.
", + "UpdateBackendAuthOAuthConfig$RedirectSignOutURIs" : "Redirect URLs that OAuth uses when a user signs out of an Amplify app.
" } }, "__string" : { @@ -528,7 +534,7 @@ "BackendAPICodegenRespObj$Operation" : "The name of the operation.
", "BackendAPICodegenRespObj$Status" : "The current status of the request.
", "BackendAPIReqObj$ResourceName" : "The name of this resource.
", - "BackendAPIResourceConfig$ApiName" : "The API name used to interact with the data model, configured as a part of the amplify project.
", + "BackendAPIResourceConfig$ApiName" : "The API name used to interact with the data model, configured as a part of your Amplify project.
", "BackendAPIResourceConfig$Service" : "The service used to provision and interact with the data model.
", "BackendAPIResourceConfig$TransformSchema" : "The definition of the data model in the annotated transform of the GraphQL schema.
", "BackendAPIRespObj$AppId" : "The app ID.
", @@ -537,18 +543,22 @@ "BackendAPIRespObj$JobId" : "The ID for the job.
", "BackendAPIRespObj$Operation" : "The name of the operation.
", "BackendAPIRespObj$Status" : "The current status of the request.
", + "BackendAuthAppleProviderConfig$ClientId" : "Describes the client_id (also called Services ID) that comes from Apple.
", + "BackendAuthAppleProviderConfig$KeyId" : "Describes the key_id that comes from Apple.
", + "BackendAuthAppleProviderConfig$PrivateKey" : "Describes the private_key that comes from Apple.
", + "BackendAuthAppleProviderConfig$TeamId" : "Describes the team_id that comes from Apple.
", "BackendAuthRespObj$AppId" : "The app ID.
", "BackendAuthRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "BackendAuthRespObj$Error" : "If the request fails, this error is returned.
", "BackendAuthRespObj$JobId" : "The ID for the job.
", "BackendAuthRespObj$Operation" : "The name of the operation.
", "BackendAuthRespObj$Status" : "The current status of the request.
", - "BackendAuthSocialProviderConfig$ClientId" : "Describes the client_id which can be obtained from the third-party social federation provider.
", - "BackendAuthSocialProviderConfig$ClientSecret" : "Describes the client_secret which can be obtained from third-party social federation providers.
", + "BackendAuthSocialProviderConfig$ClientId" : "Describes the client_id, which can be obtained from the third-party social federation provider.
", + "BackendAuthSocialProviderConfig$ClientSecret" : "Describes the client_secret, which can be obtained from third-party social federation providers.
", "BackendConfigRespObj$AppId" : "The app ID.
", "BackendConfigRespObj$BackendManagerAppId" : "The app ID for the backend manager.
", "BackendConfigRespObj$Error" : "If the request fails, this error is returned.
", - "BackendJobReqObj$Operation" : "Filters the list of response objects to only include those with the specified operation name.
", + "BackendJobReqObj$Operation" : "Filters the list of response objects to include only those with the specified operation name.
", "BackendJobReqObj$Status" : "Filters the list of response objects to include only those with the specified status.
", "BackendJobRespObj$AppId" : "The app ID.
", "BackendJobRespObj$BackendEnvironmentName" : "The name of the backend environment.
", diff --git a/models/apis/devops-guru/2020-12-01/paginators-1.json b/models/apis/devops-guru/2020-12-01/paginators-1.json index a0d97428599..67745d4d9f3 100644 --- a/models/apis/devops-guru/2020-12-01/paginators-1.json +++ b/models/apis/devops-guru/2020-12-01/paginators-1.json @@ -4,11 +4,18 @@ "input_token": "NextToken", "output_token": "NextToken", "result_key": [ - "CloudFormation" + "CloudFormation", + "Service" ] }, "GetCostEstimation": { "input_token": "NextToken", + "non_aggregate_keys": [ + "Status", + "TotalCost", + "TimeRange", + "ResourceCollection" + ], "output_token": "NextToken", "result_key": [ "Costs" diff --git a/models/apis/directconnect/2012-10-25/api-2.json b/models/apis/directconnect/2012-10-25/api-2.json index 7b8c6450e47..34268aa77c2 100644 --- a/models/apis/directconnect/2012-10-25/api-2.json +++ b/models/apis/directconnect/2012-10-25/api-2.json @@ -987,6 +987,7 @@ "deprecated":true }, "AwsDeviceV2":{"type":"string"}, + "AwsLogicalDeviceId":{"type":"string"}, "BGPAuthKey":{"type":"string"}, "BGPPeer":{ "type":"structure", @@ -999,7 +1000,8 @@ "customerAddress":{"shape":"CustomerAddress"}, "bgpPeerState":{"shape":"BGPPeerState"}, "bgpStatus":{"shape":"BGPStatus"}, - "awsDeviceV2":{"shape":"AwsDeviceV2"} + "awsDeviceV2":{"shape":"AwsDeviceV2"}, + "awsLogicalDeviceId":{"shape":"AwsLogicalDeviceId"} } }, "BGPPeerId":{"type":"string"}, @@ -1109,6 +1111,7 @@ "awsDevice":{"shape":"AwsDevice"}, "jumboFrameCapable":{"shape":"JumboFrameCapable"}, "awsDeviceV2":{"shape":"AwsDeviceV2"}, + "awsLogicalDeviceId":{"shape":"AwsLogicalDeviceId"}, "hasLogicalRedundancy":{"shape":"HasLogicalRedundancy"}, "tags":{"shape":"TagList"}, "providerName":{"shape":"ProviderName"}, @@ -1751,6 +1754,7 @@ "awsDevice":{"shape":"AwsDevice"}, "jumboFrameCapable":{"shape":"JumboFrameCapable"}, "awsDeviceV2":{"shape":"AwsDeviceV2"}, + "awsLogicalDeviceId":{"shape":"AwsLogicalDeviceId"}, "hasLogicalRedundancy":{"shape":"HasLogicalRedundancy"}, "tags":{"shape":"TagList"}, "providerName":{"shape":"ProviderName"} @@ -1795,6 +1799,7 @@ "minimumLinks":{"shape":"Count"}, "awsDevice":{"shape":"AwsDevice"}, "awsDeviceV2":{"shape":"AwsDeviceV2"}, + "awsLogicalDeviceId":{"shape":"AwsLogicalDeviceId"}, "connections":{"shape":"ConnectionList"}, "allowsHostedConnections":{"shape":"BooleanFlag"}, "jumboFrameCapable":{"shape":"JumboFrameCapable"}, @@ -2256,6 +2261,7 @@ "bgpPeers":{"shape":"BGPPeerList"}, "region":{"shape":"Region"}, "awsDeviceV2":{"shape":"AwsDeviceV2"}, + "awsLogicalDeviceId":{"shape":"AwsLogicalDeviceId"}, "tags":{"shape":"TagList"} } }, diff --git a/models/apis/directconnect/2012-10-25/docs-2.json b/models/apis/directconnect/2012-10-25/docs-2.json index af35fb798f1..858c0576406 100644 --- a/models/apis/directconnect/2012-10-25/docs-2.json +++ b/models/apis/directconnect/2012-10-25/docs-2.json @@ -1,65 +1,65 @@ { "version": "2.0", - "service": "AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all AWS Regions except the China (Beijing) and (China) Ningxia Regions. AWS resources in the China Regions can only be accessed through locations associated with those Regions.
", + "service": "Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
", "operations": { "AcceptDirectConnectGatewayAssociationProposal": "Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
", - "AllocateConnectionOnInterconnect": "Deprecated. Use AllocateHostedConnection instead.
Creates a hosted connection on an interconnect.
Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
Intended for use by AWS Direct Connect Partners only.
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.
Intended for use by AWS Direct Connect Partners only.
Provisions a private virtual interface to be owned by the specified AWS account.
Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
Provisions a public virtual interface to be owned by the specified AWS account.
The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account.
Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
", - "AllocateTransitVirtualInterface": "Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account.
After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS is interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.
Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.
For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.
", - "AssociateHostedConnection": "Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.
Intended for use by AWS Direct Connect Partners only.
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an AWS Direct Connect dedicated connection.
You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.
For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the AWS Direct Connect User Guide.
", - "AssociateVirtualInterface": "Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.
Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.
To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.
", + "AllocateConnectionOnInterconnect": "Deprecated. Use AllocateHostedConnection instead.
Creates a hosted connection on an interconnect.
Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
Intended for use by Direct Connect Partners only.
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.
Intended for use by Direct Connect Partners only.
Provisions a private virtual interface to be owned by the specified account.
Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
Provisions a public virtual interface to be owned by the specified account.
The owner of a connection calls this function to provision a public virtual interface to be owned by the specified account.
Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
", + "AllocateTransitVirtualInterface": "Provisions a transit virtual interface to be owned by the specified account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
The owner of a connection provisions a transit virtual interface to be owned by the specified account.
After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.
Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.
For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.
", + "AssociateHostedConnection": "Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to Amazon Web Services as it is being migrated.
Intended for use by Direct Connect Partners only.
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.
You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.
For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.
", + "AssociateVirtualInterface": "Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.
Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.
To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.
", "ConfirmConnection": "Confirms the creation of the specified hosted connection on an interconnect.
Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.
Accepts ownership of a private virtual interface created by another AWS account.
After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.
", - "ConfirmPublicVirtualInterface": "Accepts ownership of a public virtual interface created by another AWS account.
After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.
", - "ConfirmTransitVirtualInterface": "Accepts ownership of a transit virtual interface created by another AWS account.
After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
", - "CreateBGPPeer": "Creates a BGP peer on the specified virtual interface.
You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWS resources that also use that address family.
If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.
When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.
", - "CreateConnection": "Creates a connection between a customer network and a specific AWS Direct Connect location.
A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.
To find the locations for your Region, use DescribeLocations.
You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.
", - "CreateDirectConnectGateway": "Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.
", + "ConfirmPrivateVirtualInterface": "Accepts ownership of a private virtual interface created by another account.
After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.
", + "ConfirmPublicVirtualInterface": "Accepts ownership of a public virtual interface created by another account.
After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.
", + "ConfirmTransitVirtualInterface": "Accepts ownership of a transit virtual interface created by another account.
After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
", + "CreateBGPPeer": "Creates a BGP peer on the specified virtual interface.
You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.
If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.
When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.
", + "CreateConnection": "Creates a connection between a customer network and a specific Direct Connect location.
A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router.
To find the locations for your Region, use DescribeLocations.
You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.
", + "CreateDirectConnectGateway": "Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.
", "CreateDirectConnectGatewayAssociation": "Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.
", - "CreateDirectConnectGatewayAssociationProposal": "Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any AWS account.
", - "CreateInterconnect": "Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.
An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.
You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.
For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect Partner.
Intended for use by AWS Direct Connect Partners only.
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.
All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same AWS Direct Connect endpoint.
You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.
You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.
If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.
", - "CreatePrivateVirtualInterface": "Creates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different AWS Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.
Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.
", - "CreatePublicVirtualInterface": "Creates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon S3.
When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.
Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any account.
", + "CreateInterconnect": "Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect router.
You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.
For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.
Intended for use by Direct Connect Partners only.
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.
All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.
You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created.
You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.
If the account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.
", + "CreatePrivateVirtualInterface": "Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.
Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.
", + "CreatePublicVirtualInterface": "Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.
When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.
Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.
If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.
Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.
", "DeleteBGPPeer": "Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
You cannot delete the last BGP peer from a virtual interface.
", - "DeleteConnection": "Deletes the specified connection.
Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately.
", + "DeleteConnection": "Deletes the specified connection.
Deleting a connection only stops the Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the Direct Connect location, you must cancel your service with them separately.
", "DeleteDirectConnectGateway": "Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.
", "DeleteDirectConnectGatewayAssociation": "Deletes the association between the specified Direct Connect gateway and virtual private gateway.
We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
", - "DeleteInterconnect": "Deletes the specified interconnect.
Intended for use by AWS Direct Connect Partners only.
Deletes the specified interconnect.
Intended for use by Direct Connect Partners only.
Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
", "DeleteVirtualInterface": "Deletes a virtual interface.
", - "DescribeConnectionLoa": "Deprecated. Use DescribeLoa instead.
Gets the LOA-CFA for a connection.
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.
", + "DescribeConnectionLoa": "Deprecated. Use DescribeLoa instead.
Gets the LOA-CFA for a connection.
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.
", "DescribeConnections": "Displays the specified connection or all connections in this Region.
", - "DescribeConnectionsOnInterconnect": "Deprecated. Use DescribeHostedConnections instead.
Lists the connections that have been provisioned on the specified interconnect.
Intended for use by AWS Direct Connect Partners only.
Deprecated. Use DescribeHostedConnections instead.
Lists the connections that have been provisioned on the specified interconnect.
Intended for use by Direct Connect Partners only.
Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
", "DescribeDirectConnectGatewayAssociations": "Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:
A Direct Connect gateway
The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway.
A virtual private gateway
The response contains the Direct Connect gateway.
A transit gateway
The response contains the Direct Connect gateway.
A Direct Connect gateway and a virtual private gateway
The response contains the association between the Direct Connect gateway and virtual private gateway.
A Direct Connect gateway and a transit gateway
The response contains the association between the Direct Connect gateway and transit gateway.
Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.
", "DescribeDirectConnectGateways": "Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.
", - "DescribeHostedConnections": "Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
Intended for use by AWS Direct Connect Partners only.
Deprecated. Use DescribeLoa instead.
Gets the LOA-CFA for the specified interconnect.
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.
", - "DescribeInterconnects": "Lists the interconnects owned by the AWS account or only the specified interconnect.
", + "DescribeHostedConnections": "Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
Intended for use by Direct Connect Partners only.
Deprecated. Use DescribeLoa instead.
Gets the LOA-CFA for the specified interconnect.
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.
", + "DescribeInterconnects": "Lists the interconnects owned by the account or only the specified interconnect.
", "DescribeLags": "Describes all your link aggregation groups (LAG) or the specified LAG.
", - "DescribeLoa": "Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.
", - "DescribeLocations": "Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.
", - "DescribeTags": "Describes the tags associated with the specified AWS Direct Connect resources.
", - "DescribeVirtualGateways": "Lists the virtual private gateways owned by the AWS account.
You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway.
", - "DescribeVirtualInterfaces": "Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer network.
", - "DisassociateConnectionFromLag": "Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is automatically converted to an interconnect.
If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.
", - "DisassociateMacSecKey": "Removes the association between a MAC Security (MACsec) security key and an AWS Direct Connect dedicated connection.
", + "DescribeLoa": "Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.
", + "DescribeLocations": "Lists the Direct Connect locations in the current Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.
", + "DescribeTags": "Describes the tags associated with the specified Direct Connect resources.
", + "DescribeVirtualGateways": "Lists the virtual private gateways owned by the account.
You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
", + "DescribeVirtualInterfaces": "Displays all virtual interfaces for an account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.
A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.
", + "DisassociateConnectionFromLag": "Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect.
If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.
", + "DisassociateMacSecKey": "Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
", "ListVirtualInterfaceTestHistory": "Lists the virtual interface failover test history.
", "StartBgpFailoverTest": "Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.
You can run the test on public, private, transit, and hosted virtual interfaces.
You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.
If you need to stop the test before the test interval completes, use StopBgpFailoverTest.
", "StopBgpFailoverTest": "Stops the virtual interface failover test.
", - "TagResource": "Adds the specified tags to the specified AWS Direct Connect resource. Each resource can have a maximum of 50 tags.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.
", - "UntagResource": "Removes one or more tags from the specified AWS Direct Connect resource.
", - "UpdateConnection": "Updates the AWS Direct Connect dedicated connection configuration.
You can update the following parameters for a connection:
The connection name
The connection's MAC Security (MACsec) encryption mode.
Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.
", + "UntagResource": "Removes one or more tags from the specified Direct Connect resource.
", + "UpdateConnection": "Updates the Direct Connect dedicated connection configuration.
You can update the following parameters for a connection:
The connection name
The connection's MAC Security (MACsec) encryption mode.
Updates the specified attributes of the Direct Connect gateway association.
Add or remove prefixes from the association.
", - "UpdateLag": "Updates the attributes of the specified link aggregation group (LAG).
You can update the following LAG attributes:
The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
The LAG's MACsec encryption mode.
AWS assigns this value to each connection which is part of the LAG.
The tags
If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.
Updates the attributes of the specified link aggregation group (LAG).
You can update the following LAG attributes:
The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
The LAG's MACsec encryption mode.
Amazon Web Services assigns this value to each connection which is part of the LAG.
The tags
If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.
Updates the specified attributes of the specified virtual private interface.
Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual q interface supports jumbo frames, call DescribeVirtualInterfaces.
" }, "shapes": { @@ -202,7 +202,7 @@ "refs": { "Connection$awsDevice": "The Direct Connect endpoint on which the physical connection terminates.
", "Interconnect$awsDevice": "The Direct Connect endpoint on which the physical connection terminates.
", - "Lag$awsDevice": "The AWS Direct Connect endpoint that hosts the LAG.
" + "Lag$awsDevice": "The Direct Connect endpoint that hosts the LAG.
" } }, "AwsDeviceV2": { @@ -211,10 +211,20 @@ "BGPPeer$awsDeviceV2": "The Direct Connect endpoint on which the BGP peer terminates.
", "Connection$awsDeviceV2": "The Direct Connect endpoint on which the physical connection terminates.
", "Interconnect$awsDeviceV2": "The Direct Connect endpoint on which the physical connection terminates.
", - "Lag$awsDeviceV2": "The AWS Direct Connect endpoint that hosts the LAG.
", + "Lag$awsDeviceV2": "The Direct Connect endpoint that hosts the LAG.
", "VirtualInterface$awsDeviceV2": "The Direct Connect endpoint on which the virtual interface terminates.
" } }, + "AwsLogicalDeviceId": { + "base": null, + "refs": { + "BGPPeer$awsLogicalDeviceId": null, + "Connection$awsLogicalDeviceId": "The Direct Connect endpoint that terminates a physical connection's BGP sessions.
", + "Interconnect$awsLogicalDeviceId": "The Direct Connect endpoint that terminates a physical connection's BGP sessions.
", + "Lag$awsLogicalDeviceId": "The Direct Connect endpoint that terminates a physical connection's BGP sessions.
", + "VirtualInterface$awsLogicalDeviceId": "The Direct Connect endpoint that terminates a physical connection's BGP sessions.
" + } + }, "BGPAuthKey": { "base": null, "refs": { @@ -272,8 +282,8 @@ "Bandwidth": { "base": null, "refs": { - "AllocateConnectionOnInterconnectRequest$bandwidth": "The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
", - "AllocateHostedConnectionRequest$bandwidth": "The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
", + "AllocateConnectionOnInterconnectRequest$bandwidth": "The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
", + "AllocateHostedConnectionRequest$bandwidth": "The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
", "Connection$bandwidth": "The bandwidth of the connection.
", "CreateConnectionRequest$bandwidth": "The bandwidth of the connection.
", "CreateInterconnectRequest$bandwidth": "The port bandwidth, in Gbps. The possible values are 1 and 10.
", @@ -348,7 +358,7 @@ } }, "Connection": { - "base": "Information about an AWS Direct Connect connection.
", + "base": "Information about an Direct Connect connection.
", "refs": { "ConnectionList$member": null } @@ -858,7 +868,7 @@ "Connection$encryptionMode": "The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
The connection MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
The LAG MAC Security (MACsec) encryption mode.
AWS applies the value to all connections which are part of the LAG.
" + "UpdateLagRequest$encryptionMode": "The LAG MAC Security (MACsec) encryption mode.
Amazon Web Services applies the value to all connections which are part of the LAG.
" } }, "EndTime": { @@ -1045,7 +1055,7 @@ } }, "Location": { - "base": "Information about an AWS Direct Connect location.
", + "base": "Information about an Direct Connect location.
", "refs": { "LocationList$member": null } @@ -1176,22 +1186,22 @@ "OwnerAccount": { "base": null, "refs": { - "AcceptDirectConnectGatewayAssociationProposalRequest$associatedGatewayOwnerAccount": "The ID of the AWS account that owns the virtual private gateway or transit gateway.
", - "AllocateConnectionOnInterconnectRequest$ownerAccount": "The ID of the AWS account of the customer for whom the connection will be provisioned.
", - "AllocateHostedConnectionRequest$ownerAccount": "The ID of the AWS account ID of the customer for the connection.
", - "AllocatePrivateVirtualInterfaceRequest$ownerAccount": "The ID of the AWS account that owns the virtual private interface.
", - "AllocatePublicVirtualInterfaceRequest$ownerAccount": "The ID of the AWS account that owns the public virtual interface.
", - "AllocateTransitVirtualInterfaceRequest$ownerAccount": "The ID of the AWS account that owns the transit virtual interface.
", - "AssociatedGateway$ownerAccount": "The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
", - "Connection$ownerAccount": "The ID of the AWS account that owns the connection.
", - "CreateDirectConnectGatewayAssociationProposalRequest$directConnectGatewayOwnerAccount": "The ID of the AWS account that owns the Direct Connect gateway.
", - "DirectConnectGateway$ownerAccount": "The ID of the AWS account that owns the Direct Connect gateway.
", - "DirectConnectGatewayAssociation$directConnectGatewayOwnerAccount": "The ID of the AWS account that owns the associated gateway.
", - "DirectConnectGatewayAssociation$virtualGatewayOwnerAccount": "The ID of the AWS account that owns the virtual private gateway.
", - "DirectConnectGatewayAssociationProposal$directConnectGatewayOwnerAccount": "The ID of the AWS account that owns the Direct Connect gateway.
", - "DirectConnectGatewayAttachment$virtualInterfaceOwnerAccount": "The ID of the AWS account that owns the virtual interface.
", - "Lag$ownerAccount": "The ID of the AWS account that owns the LAG.
", - "VirtualInterface$ownerAccount": "The ID of the AWS account that owns the virtual interface.
", + "AcceptDirectConnectGatewayAssociationProposalRequest$associatedGatewayOwnerAccount": "The ID of the account that owns the virtual private gateway or transit gateway.
", + "AllocateConnectionOnInterconnectRequest$ownerAccount": "The ID of the account of the customer for whom the connection will be provisioned.
", + "AllocateHostedConnectionRequest$ownerAccount": "The ID of the account ID of the customer for the connection.
", + "AllocatePrivateVirtualInterfaceRequest$ownerAccount": "The ID of the account that owns the virtual private interface.
", + "AllocatePublicVirtualInterfaceRequest$ownerAccount": "The ID of the account that owns the public virtual interface.
", + "AllocateTransitVirtualInterfaceRequest$ownerAccount": "The ID of the account that owns the transit virtual interface.
", + "AssociatedGateway$ownerAccount": "The ID of the account that owns the associated virtual private gateway or transit gateway.
", + "Connection$ownerAccount": "The ID of the account that owns the connection.
", + "CreateDirectConnectGatewayAssociationProposalRequest$directConnectGatewayOwnerAccount": "The ID of the account that owns the Direct Connect gateway.
", + "DirectConnectGateway$ownerAccount": "The ID of the account that owns the Direct Connect gateway.
", + "DirectConnectGatewayAssociation$directConnectGatewayOwnerAccount": "The ID of the account that owns the associated gateway.
", + "DirectConnectGatewayAssociation$virtualGatewayOwnerAccount": "The ID of the account that owns the virtual private gateway.
", + "DirectConnectGatewayAssociationProposal$directConnectGatewayOwnerAccount": "The ID of the account that owns the Direct Connect gateway.
", + "DirectConnectGatewayAttachment$virtualInterfaceOwnerAccount": "The ID of the account that owns the virtual interface.
", + "Lag$ownerAccount": "The ID of the account that owns the LAG.
", + "VirtualInterface$ownerAccount": "The ID of the account that owns the virtual interface.
", "VirtualInterfaceTestHistory$ownerAccount": "The owner ID of the tested virtual interface.
" } }, @@ -1213,7 +1223,7 @@ "PartnerName": { "base": null, "refs": { - "Connection$partnerName": "The name of the AWS Direct Connect service provider associated with the connection.
" + "Connection$partnerName": "The name of the Direct Connect service provider associated with the connection.
" } }, "PortEncryptionStatus": { @@ -1254,18 +1264,18 @@ "base": null, "refs": { "AssociatedGateway$region": "The Region where the associated gateway is located.
", - "Connection$region": "The AWS Region where the connection is located.
", - "Interconnect$region": "The AWS Region where the connection is located.
", - "Lag$region": "The AWS Region where the connection is located.
", - "Location$region": "The AWS Region for the location.
", - "VirtualInterface$region": "The AWS Region where the virtual interface is located.
" + "Connection$region": "The Region where the connection is located.
", + "Interconnect$region": "The Region where the connection is located.
", + "Lag$region": "The Region where the connection is located.
", + "Location$region": "The Region for the location.
", + "VirtualInterface$region": "The Region where the virtual interface is located.
" } }, "RequestMACSec": { "base": null, "refs": { - "CreateConnectionRequest$requestMACSec": "Indicates whether you want the connection to support MAC Security (MACsec).
MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the AWS Direct Connect User Guide.
", - "CreateLagRequest$requestMACSec": "Indicates whether the connection will support MAC Security (MACsec).
All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the AWS Direct Connect User Guide.
Indicates whether you want the connection to support MAC Security (MACsec).
MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.
", + "CreateLagRequest$requestMACSec": "Indicates whether the connection will support MAC Security (MACsec).
All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.
Information about a tag associated with an AWS Direct Connect resource.
", + "base": "Information about a tag associated with an Direct Connect resource.
", "refs": { "ResourceTagList$member": null } @@ -1304,18 +1314,18 @@ "RouteFilterPrefixList": { "base": null, "refs": { - "AcceptDirectConnectGatewayAssociationProposalRequest$overrideAllowedPrefixesToDirectConnectGateway": "Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.
For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.
", + "AcceptDirectConnectGatewayAssociationProposalRequest$overrideAllowedPrefixesToDirectConnectGateway": "Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.
For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.
", "CreateDirectConnectGatewayAssociationProposalRequest$addAllowedPrefixesToDirectConnectGateway": "The Amazon VPC prefixes to advertise to the Direct Connect gateway.
", "CreateDirectConnectGatewayAssociationProposalRequest$removeAllowedPrefixesToDirectConnectGateway": "The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
", - "CreateDirectConnectGatewayAssociationRequest$addAllowedPrefixesToDirectConnectGateway": "The Amazon VPC prefixes to advertise to the Direct Connect gateway
This parameter is required when you create an association to a transit gateway.
For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.
", + "CreateDirectConnectGatewayAssociationRequest$addAllowedPrefixesToDirectConnectGateway": "The Amazon VPC prefixes to advertise to the Direct Connect gateway
This parameter is required when you create an association to a transit gateway.
For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.
", "DirectConnectGatewayAssociation$allowedPrefixesToDirectConnectGateway": "The Amazon VPC prefixes to advertise to the Direct Connect gateway.
", "DirectConnectGatewayAssociationProposal$existingAllowedPrefixesToDirectConnectGateway": "The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
", "DirectConnectGatewayAssociationProposal$requestedAllowedPrefixesToDirectConnectGateway": "The Amazon VPC prefixes to advertise to the Direct Connect gateway.
", - "NewPublicVirtualInterface$routeFilterPrefixes": "The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
", - "NewPublicVirtualInterfaceAllocation$routeFilterPrefixes": "The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
", + "NewPublicVirtualInterface$routeFilterPrefixes": "The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
", + "NewPublicVirtualInterfaceAllocation$routeFilterPrefixes": "The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
", "UpdateDirectConnectGatewayAssociationRequest$addAllowedPrefixesToDirectConnectGateway": "The Amazon VPC prefixes to advertise to the Direct Connect gateway.
", "UpdateDirectConnectGatewayAssociationRequest$removeAllowedPrefixesToDirectConnectGateway": "The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
", - "VirtualInterface$routeFilterPrefixes": "The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
" + "VirtualInterface$routeFilterPrefixes": "The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
" } }, "RouterConfig": { @@ -1532,7 +1542,7 @@ "VirtualGatewayRegion": { "base": null, "refs": { - "DirectConnectGatewayAssociation$virtualGatewayRegion": "The AWS Region where the virtual private gateway is located.
" + "DirectConnectGatewayAssociation$virtualGatewayRegion": "The Region where the virtual private gateway is located.
" } }, "VirtualGatewayState": { @@ -1598,7 +1608,7 @@ "VirtualInterfaceRegion": { "base": null, "refs": { - "DirectConnectGatewayAttachment$virtualInterfaceRegion": "The AWS Region where the virtual interface is located.
" + "DirectConnectGatewayAttachment$virtualInterfaceRegion": "The Region where the virtual interface is located.
" } }, "VirtualInterfaceState": { diff --git a/models/apis/lex-models/2017-04-19/api-2.json b/models/apis/lex-models/2017-04-19/api-2.json index a7fac71ebac..c161b1a5ff4 100644 --- a/models/apis/lex-models/2017-04-19/api-2.json +++ b/models/apis/lex-models/2017-04-19/api-2.json @@ -452,6 +452,37 @@ {"shape":"BadRequestException"} ] }, + "GetMigration":{ + "name":"GetMigration", + "http":{ + "method":"GET", + "requestUri":"/migrations/{migrationId}", + "responseCode":200 + }, + "input":{"shape":"GetMigrationRequest"}, + "output":{"shape":"GetMigrationResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ] + }, + "GetMigrations":{ + "name":"GetMigrations", + "http":{ + "method":"GET", + "requestUri":"/migrations", + "responseCode":200 + }, + "input":{"shape":"GetMigrationsRequest"}, + "output":{"shape":"GetMigrationsResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ] + }, "GetSlotType":{ "name":"GetSlotType", "http":{ @@ -614,6 +645,23 @@ {"shape":"BadRequestException"} ] }, + "StartMigration":{ + "name":"StartMigration", + "http":{ + "method":"POST", + "requestUri":"/migrations", + "responseCode":202 + }, + "input":{"shape":"StartMigrationRequest"}, + "output":{"shape":"StartMigrationResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"} + ] + }, "TagResource":{ "name":"TagResource", "http":{ @@ -650,6 +698,14 @@ } }, "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":403}, + "exception":true + }, "AliasName":{ "type":"string", "max":100, @@ -1680,6 +1736,74 @@ "nextToken":{"shape":"NextToken"} } }, + "GetMigrationRequest":{ + "type":"structure", + "required":["migrationId"], + "members":{ + "migrationId":{ + "shape":"MigrationId", + "location":"uri", + "locationName":"migrationId" + } + } + }, + "GetMigrationResponse":{ + "type":"structure", + "members":{ + "migrationId":{"shape":"MigrationId"}, + "v1BotName":{"shape":"BotName"}, + "v1BotVersion":{"shape":"Version"}, + "v1BotLocale":{"shape":"Locale"}, + "v2BotId":{"shape":"V2BotId"}, + "v2BotRole":{"shape":"IamRoleArn"}, + "migrationStatus":{"shape":"MigrationStatus"}, + "migrationStrategy":{"shape":"MigrationStrategy"}, + "migrationTimestamp":{"shape":"Timestamp"}, + "alerts":{"shape":"MigrationAlerts"} + } + }, + "GetMigrationsRequest":{ + "type":"structure", + "members":{ + "sortByAttribute":{ + "shape":"MigrationSortAttribute", + "location":"querystring", + "locationName":"sortByAttribute" + }, + "sortByOrder":{ + "shape":"SortOrder", + "location":"querystring", + "locationName":"sortByOrder" + }, + "v1BotNameContains":{ + "shape":"BotName", + "location":"querystring", + "locationName":"v1BotNameContains" + }, + "migrationStatusEquals":{ + "shape":"MigrationStatus", + "location":"querystring", + "locationName":"migrationStatusEquals" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "GetMigrationsResponse":{ + "type":"structure", + "members":{ + "migrationSummaries":{"shape":"MigrationSummaryList"}, + "nextToken":{"shape":"NextToken"} + } + }, "GetSlotTypeRequest":{ "type":"structure", "required":[ @@ -1918,7 +2042,7 @@ "type":"string", "max":2048, "min":20, - "pattern":"arn:aws:lambda:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?" + "pattern":"arn:aws[a-zA-Z-]*:lambda:[a-z]+-[a-z]+(-[a-z]+)*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?" }, "LimitExceededException":{ "type":"structure", @@ -2053,6 +2177,83 @@ "max":5, "min":1 }, + "MigrationAlert":{ + "type":"structure", + "members":{ + "type":{"shape":"MigrationAlertType"}, + "message":{"shape":"MigrationAlertMessage"}, + "details":{"shape":"MigrationAlertDetails"}, + "referenceURLs":{"shape":"MigrationAlertReferenceURLs"} + } + }, + "MigrationAlertDetail":{"type":"string"}, + "MigrationAlertDetails":{ + "type":"list", + "member":{"shape":"MigrationAlertDetail"} + }, + "MigrationAlertMessage":{"type":"string"}, + "MigrationAlertReferenceURL":{"type":"string"}, + "MigrationAlertReferenceURLs":{ + "type":"list", + "member":{"shape":"MigrationAlertReferenceURL"} + }, + "MigrationAlertType":{ + "type":"string", + "enum":[ + "ERROR", + "WARN" + ] + }, + "MigrationAlerts":{ + "type":"list", + "member":{"shape":"MigrationAlert"} + }, + "MigrationId":{ + "type":"string", + "max":10, + "min":10, + "pattern":"^[0-9a-zA-Z]+$" + }, + "MigrationSortAttribute":{ + "type":"string", + "enum":[ + "V1_BOT_NAME", + "MIGRATION_DATE_TIME" + ] + }, + "MigrationStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + }, + "MigrationStrategy":{ + "type":"string", + "enum":[ + "CREATE_NEW", + "UPDATE_EXISTING" + ] + }, + "MigrationSummary":{ + "type":"structure", + "members":{ + "migrationId":{"shape":"MigrationId"}, + "v1BotName":{"shape":"BotName"}, + "v1BotVersion":{"shape":"Version"}, + "v1BotLocale":{"shape":"Locale"}, + "v2BotId":{"shape":"V2BotId"}, + "v2BotRole":{"shape":"IamRoleArn"}, + "migrationStatus":{"shape":"MigrationStatus"}, + "migrationStrategy":{"shape":"MigrationStrategy"}, + "migrationTimestamp":{"shape":"Timestamp"} + } + }, + "MigrationSummaryList":{ + "type":"list", + "member":{"shape":"MigrationSummary"} + }, "Name":{ "type":"string", "max":100, @@ -2499,6 +2700,13 @@ "TOP_RESOLUTION" ] }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, "StartImportRequest":{ "type":"structure", "required":[ @@ -2525,6 +2733,36 @@ "createdDate":{"shape":"Timestamp"} } }, + "StartMigrationRequest":{ + "type":"structure", + "required":[ + "v1BotName", + "v1BotVersion", + "v2BotName", + "v2BotRole", + "migrationStrategy" + ], + "members":{ + "v1BotName":{"shape":"BotName"}, + "v1BotVersion":{"shape":"Version"}, + "v2BotName":{"shape":"V2BotName"}, + "v2BotRole":{"shape":"IamRoleArn"}, + "migrationStrategy":{"shape":"MigrationStrategy"} + } + }, + "StartMigrationResponse":{ + "type":"structure", + "members":{ + "v1BotName":{"shape":"BotName"}, + "v1BotVersion":{"shape":"Version"}, + "v1BotLocale":{"shape":"Locale"}, + "v2BotId":{"shape":"V2BotId"}, + "v2BotRole":{"shape":"IamRoleArn"}, + "migrationId":{"shape":"MigrationId"}, + "migrationStrategy":{"shape":"MigrationStrategy"}, + "migrationTimestamp":{"shape":"Timestamp"} + } + }, "Statement":{ "type":"structure", "required":["messages"], @@ -2669,6 +2907,18 @@ "max":2000, "min":1 }, + "V2BotId":{ + "type":"string", + "max":10, + "min":10, + "pattern":"^[0-9a-zA-Z]+$" + }, + "V2BotName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^([0-9a-zA-Z][_-]?)+$" + }, "Value":{ "type":"string", "max":140, diff --git a/models/apis/lex-models/2017-04-19/docs-2.json b/models/apis/lex-models/2017-04-19/docs-2.json index 6568ce3f1b8..0ff43ca8cff 100644 --- a/models/apis/lex-models/2017-04-19/docs-2.json +++ b/models/apis/lex-models/2017-04-19/docs-2.json @@ -29,20 +29,28 @@ "GetIntent": "Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the lex:GetIntent action.
Gets information about all of the versions of an intent.
The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version.
The GetIntentVersions operation always returns at least one version, the $LATEST version.
This operation requires permissions for the lex:GetIntentVersions action.
Returns intent information as follows:
If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string.
If you don't specify the nameContains field, returns information about the $LATEST version of all intents.
The operation requires permission for the lex:GetIntents action.
Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.
", + "GetMigrations": "Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
", "GetSlotType": "Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.
This operation requires permissions for the lex:GetSlotType action.
Gets information about all versions of a slot type.
The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version.
The GetSlotTypeVersions operation always returns at least one version, the $LATEST version.
This operation requires permissions for the lex:GetSlotTypeVersions action.
Returns slot type information as follows:
If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string.
If you don't specify the nameContains field, returns information about the $LATEST version of all slot types.
The operation requires permission for the lex:GetSlotTypes action.
Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.
For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance.
After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.
If you set childDirected field to true when you created your bot, or if you opted out of participating in improving Amazon Lex, utterances are not available.
This operation requires permissions for the lex:GetUtterancesView action.
Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.
For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance.
After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.
If you set childDirected field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available.
This operation requires permissions for the lex:GetUtterancesView action.
Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
", "PutBot": "Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works.
If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.
This operation requires permissions for the lex:PutBot action. For more information, see security-iam.
Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the lex:PutBotAlias action.
Creates an intent or replaces an existing intent.
To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent.
To create an intent or replace an existing intent, you must provide the following:
Intent name. For example, OrderPizza.
Sample utterances. For example, \"Can I order a pizza, please.\" and \"I want to order a pizza.\"
Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.
You can specify other optional information in the request, such as:
A confirmation prompt to ask the user to confirm an intent. For example, \"Shall I order your pizza?\"
A conclusion statement to send to the user after the intent has been fulfilled. For example, \"I placed your pizza order.\"
A follow-up prompt that asks the user for additional activity. For example, asking \"Do you want to order a drink with your pizza?\"
If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT.
For more information, see how-it-works.
This operation requires permissions for the lex:PutIntent action.
Creates a custom slot type or replaces an existing custom slot type.
To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.
If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT.
This operation requires permissions for the lex:PutSlotType action.
Starts a job to import a resource to Amazon Lex.
", + "StartMigration": "Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.
For more information, see Migrating a bot in the Amazon Lex developer guide.
", "TagResource": "Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
", "UntagResource": "Removes tags from a bot, bot alias or bot channel.
" }, "shapes": { + "AccessDeniedException": { + "base": "Your IAM user or role does not have permission to call the Amazon Lex V2 APIs required to migrate your bot.
", + "refs": { + } + }, "AliasName": { "base": null, "refs": { @@ -177,12 +185,17 @@ "GetBotResponse$name": "The name of the bot.
", "GetBotVersionsRequest$name": "The name of the bot for which versions should be returned.
", "GetBotsRequest$nameContains": "Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"
", + "GetMigrationResponse$v1BotName": "The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.
", + "GetMigrationsRequest$v1BotNameContains": "Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.
", "GetUtterancesViewRequest$botName": "The name of the bot for which utterance information should be returned.
", "GetUtterancesViewResponse$botName": "The name of the bot for which utterance information was returned.
", + "MigrationSummary$v1BotName": "The name of the Amazon Lex V1 bot that is the source of the migration.
", "PutBotAliasRequest$botName": "The name of the bot.
", "PutBotAliasResponse$botName": "The name of the bot that the alias points to.
", "PutBotRequest$name": "The name of the bot. The name is not case sensitive.
", - "PutBotResponse$name": "The name of the bot.
" + "PutBotResponse$name": "The name of the bot.
", + "StartMigrationRequest$v1BotName": "The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.
", + "StartMigrationResponse$v1BotName": "The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.
" } }, "BotVersions": { @@ -655,6 +668,26 @@ "refs": { } }, + "GetMigrationRequest": { + "base": null, + "refs": { + } + }, + "GetMigrationResponse": { + "base": null, + "refs": { + } + }, + "GetMigrationsRequest": { + "base": null, + "refs": { + } + }, + "GetMigrationsResponse": { + "base": null, + "refs": { + } + }, "GetSlotTypeRequest": { "base": null, "refs": { @@ -705,7 +738,11 @@ "base": null, "refs": { "ConversationLogsRequest$iamRoleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text logs and your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access permission for the AWS KMS key used for encrypting audio logs. For more information, see Creating an IAM Role and Policy for Conversation Logs.
", - "ConversationLogsResponse$iamRoleArn": "The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.
" + "ConversationLogsResponse$iamRoleArn": "The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.
", + "GetMigrationResponse$v2BotRole": "The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
", + "MigrationSummary$v2BotRole": "The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
", + "StartMigrationRequest$v2BotRole": "The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
", + "StartMigrationResponse$v2BotRole": "The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
" } }, "ImportStatus": { @@ -857,9 +894,12 @@ "GetBotResponse$locale": "The target locale for the bot.
", "GetBuiltinIntentsRequest$locale": "A list of locales that the intent supports.
", "GetBuiltinSlotTypesRequest$locale": "A list of locales that the slot type supports.
", + "GetMigrationResponse$v1BotLocale": "The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.
", "LocaleList$member": null, + "MigrationSummary$v1BotLocale": "The locale of the Amazon Lex V1 bot that is the source of the migration.
", "PutBotRequest$locale": "Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.
The default is en-US.
The target locale for the bot.
" + "PutBotResponse$locale": "The target locale for the bot.
", + "StartMigrationResponse$v1BotLocale": "The locale used for the Amazon Lex V1 bot.
" } }, "LocaleList": { @@ -912,6 +952,7 @@ "GetBuiltinSlotTypesRequest$maxResults": "The maximum number of slot types to return in the response. The default is 10.
", "GetIntentVersionsRequest$maxResults": "The maximum number of intent versions to return in the response. The default is 10.
", "GetIntentsRequest$maxResults": "The maximum number of intents to return in the response. The default is 10.
", + "GetMigrationsRequest$maxResults": "The maximum number of migrations to return in the response. The default is 10.
", "GetSlotTypeVersionsRequest$maxResults": "The maximum number of slot type versions to return in the response. The default is 10.
", "GetSlotTypesRequest$maxResults": "The maximum number of slot types to return in the response. The default is 10.
" } @@ -943,6 +984,98 @@ "CodeHook$messageVersion": "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.
" } }, + "MigrationAlert": { + "base": "Provides information about alerts and warnings that Amazon Lex sends during a migration. The alerts include information about how to resolve the issue.
", + "refs": { + "MigrationAlerts$member": null + } + }, + "MigrationAlertDetail": { + "base": null, + "refs": { + "MigrationAlertDetails$member": null + } + }, + "MigrationAlertDetails": { + "base": null, + "refs": { + "MigrationAlert$details": "Additional details about the alert.
" + } + }, + "MigrationAlertMessage": { + "base": null, + "refs": { + "MigrationAlert$message": "A message that describes why the alert was issued.
" + } + }, + "MigrationAlertReferenceURL": { + "base": null, + "refs": { + "MigrationAlertReferenceURLs$member": null + } + }, + "MigrationAlertReferenceURLs": { + "base": null, + "refs": { + "MigrationAlert$referenceURLs": "A link to the Amazon Lex documentation that describes how to resolve the alert.
" + } + }, + "MigrationAlertType": { + "base": null, + "refs": { + "MigrationAlert$type": "The type of alert. There are two kinds of alerts:
ERROR - There was an issue with the migration that can't be resolved. The migration stops.
WARN - There was an issue with the migration that requires manual changes to the new Amazon Lex V2 bot. The migration continues.
A list of alerts and warnings that indicate issues with the migration for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 feature has a different implementation if Amazon Lex V2.
For more information, see Migrating a bot in the Amazon Lex V2 developer guide.
" + } + }, + "MigrationId": { + "base": null, + "refs": { + "GetMigrationRequest$migrationId": "The unique identifier of the migration to view. The migrationID is returned by the operation.
The unique identifier of the migration. This is the same as the identifier used when calling the GetMigration operation.
The unique identifier that Amazon Lex assigned to the migration.
", + "StartMigrationResponse$migrationId": "The unique identifier that Amazon Lex assigned to the migration.
" + } + }, + "MigrationSortAttribute": { + "base": null, + "refs": { + "GetMigrationsRequest$sortByAttribute": "The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.
" + } + }, + "MigrationStatus": { + "base": null, + "refs": { + "GetMigrationResponse$migrationStatus": "Indicates the status of the migration. When the status is COMPLETE the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.
Filters the list to contain only migrations in the specified state.
", + "MigrationSummary$migrationStatus": "The status of the operation. When the status is COMPLETE the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.
The strategy used to conduct the migration.
CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.
UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.
The strategy used to conduct the migration.
", + "StartMigrationRequest$migrationStrategy": "The strategy used to conduct the migration.
CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.
UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.
The strategy used to conduct the migration.
" + } + }, + "MigrationSummary": { + "base": "Provides information about migrating a bot from Amazon Lex V1 to Amazon Lex V2.
", + "refs": { + "MigrationSummaryList$member": null + } + }, + "MigrationSummaryList": { + "base": null, + "refs": { + "GetMigrationsResponse$migrationSummaries": "An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To see details of the migration, use the migrationId from the summary in a call to the operation.
A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
", "GetIntentsRequest$nextToken": "A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.
", "GetIntentsResponse$nextToken": "If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents.
", + "GetMigrationsRequest$nextToken": "A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.
", + "GetMigrationsResponse$nextToken": "If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of migrations.
", "GetSlotTypeVersionsRequest$nextToken": "A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
", "GetSlotTypeVersionsResponse$nextToken": "A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
", "GetSlotTypesRequest$nextToken": "A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request.
", @@ -1283,6 +1418,12 @@ "PutSlotTypeResponse$valueSelectionStrategy": "The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
" } }, + "SortOrder": { + "base": null, + "refs": { + "GetMigrationsRequest$sortByOrder": "The order so sort the list.
" + } + }, "StartImportRequest": { "base": null, "refs": { @@ -1293,6 +1434,16 @@ "refs": { } }, + "StartMigrationRequest": { + "base": null, + "refs": { + } + }, + "StartMigrationResponse": { + "base": null, + "refs": { + } + }, "Statement": { "base": "A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.
", "refs": { @@ -1329,6 +1480,7 @@ "String": { "base": null, "refs": { + "AccessDeniedException$message": null, "BadRequestException$message": null, "BotAliasMetadata$checksum": "Checksum of the bot alias.
", "BotChannelAssociation$failureReason": "If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
A timestamp for the date and time that the import job was created.
", "GetIntentResponse$lastUpdatedDate": "The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.
", "GetIntentResponse$createdDate": "The date that the intent was created.
", + "GetMigrationResponse$migrationTimestamp": "The date and time that the migration started.
", "GetSlotTypeResponse$lastUpdatedDate": "The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
", "GetSlotTypeResponse$createdDate": "The date that the slot type was created.
", "IntentMetadata$lastUpdatedDate": "The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.
", "IntentMetadata$createdDate": "The date that the intent was created.
", + "MigrationSummary$migrationTimestamp": "The date and time that the migration started.
", "PutBotAliasResponse$lastUpdatedDate": "The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
", "PutBotAliasResponse$createdDate": "The date that the bot alias was created.
", "PutBotResponse$lastUpdatedDate": "The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
", @@ -1475,6 +1629,7 @@ "SlotTypeMetadata$lastUpdatedDate": "The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.
", "SlotTypeMetadata$createdDate": "The date that the slot type was created.
", "StartImportResponse$createdDate": "A timestamp for the date and time that the import job was requested.
", + "StartMigrationResponse$migrationTimestamp": "The date and time that the migration started.
", "UtteranceData$firstUtteredDate": "The date that the utterance was first recorded.
", "UtteranceData$lastUtteredDate": "The date that the utterance was last recorded.
" } @@ -1520,6 +1675,20 @@ "UtteranceData$utteranceString": "The text that was entered by the user or the text representation of an audio clip.
" } }, + "V2BotId": { + "base": null, + "refs": { + "GetMigrationResponse$v2BotId": "The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.
", + "MigrationSummary$v2BotId": "The unique identifier of the Amazon Lex V2 that is the destination of the migration.
", + "StartMigrationResponse$v2BotId": "The unique identifier for the Amazon Lex V2 bot.
" + } + }, + "V2BotName": { + "base": null, + "refs": { + "StartMigrationRequest$v2BotName": "The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to.
If the Amazon Lex V2 bot doesn't exist, you must use the CREATE_NEW migration strategy.
If the Amazon Lex V2 bot exists, you must use the UPDATE_EXISTING migration strategy to change the contents of the Amazon Lex V2 bot.
The version of the bot. For a new bot, the version is always $LATEST.
The version of the intent.
", "GetIntentResponse$version": "The version of the intent.
", + "GetMigrationResponse$v1BotVersion": "The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.
", "GetSlotTypeRequest$version": "The version of the slot type.
", "GetSlotTypeResponse$version": "The version of the slot type.
", "Intent$intentVersion": "The version of the intent.
", "IntentMetadata$version": "The version of the intent.
", + "MigrationSummary$v1BotVersion": "The version of the Amazon Lex V1 bot that is the source of the migration.
", "PutBotAliasRequest$botVersion": "The version of the bot.
", "PutBotAliasResponse$botVersion": "The version of the bot that the alias points to.
", "PutBotResponse$version": "The version of the bot. For a new bot, the version is always $LATEST.
The version of the resource that is using the resource that you are trying to delete.
", "Slot$slotTypeVersion": "The version of the slot type.
", "SlotTypeMetadata$version": "The version of the slot type.
", + "StartMigrationRequest$v1BotVersion": "The version of the bot to migrate to Amazon Lex V2. You can migrate the $LATEST version as well as any numbered version.
The version of the bot to migrate to Amazon Lex V2.
", "UtteranceList$botVersion": "The version of the bot that processed the list.
" } }, diff --git a/models/apis/lex-models/2017-04-19/paginators-1.json b/models/apis/lex-models/2017-04-19/paginators-1.json index 57cb7bf24c9..a101307850d 100644 --- a/models/apis/lex-models/2017-04-19/paginators-1.json +++ b/models/apis/lex-models/2017-04-19/paginators-1.json @@ -40,6 +40,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "GetMigrations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "GetSlotTypeVersions": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/models/apis/pricing/2017-10-15/docs-2.json b/models/apis/pricing/2017-10-15/docs-2.json index 26e8c2e7e4b..4714d03e239 100644 --- a/models/apis/pricing/2017-10-15/docs-2.json +++ b/models/apis/pricing/2017-10-15/docs-2.json @@ -1,9 +1,9 @@ { "version": "2.0", - "service": "AWS Price List Service API (AWS Price List Service) is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The AWS Price List Service uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the AWS Price List Service to build cost control and scenario planning tools, reconcile billing data, forecast future spend for budgeting purposes, and provide cost benefit analysis that compare your internal workloads with AWS.
Use GetServices without a service code to retrieve the service codes for all AWS services, then GetServices with a service code to retreive the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
Service Endpoint
AWS Price List Service API provides the following two endpoints:
https://api.pricing.us-east-1.amazonaws.com
https://api.pricing.ap-south-1.amazonaws.com
Amazon Web Services Price List Service API (Amazon Web Services Price List Service) is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List Service uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List Service to build cost control and scenario planning tools, reconcile billing data, forecast future spend for budgeting purposes, and provide cost benefit analysis that compare your internal workloads with Amazon Web Services.
Use GetServices without a service code to retrieve the service codes for all AWS services, then GetServices with a service code to retreive the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
Service Endpoint
Amazon Web Services Price List Service API provides the following two endpoints:
https://api.pricing.us-east-1.amazonaws.com
https://api.pricing.ap-south-1.amazonaws.com
Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.
Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the AWS Billing and Cost Management User Guide.
", + "GetAttributeValues": "Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the Amazon Web Services Billing and Cost Management User Guide.
", "GetProducts": "Returns a list of all products that match the filter criteria.
" }, "shapes": { @@ -151,7 +151,7 @@ "GetProductsRequest$NextToken": "The pagination token that indicates the next set of results that you want to retrieve.
", "GetProductsResponse$FormatVersion": "The format version of the response. For example, aws_v1.
", "GetProductsResponse$NextToken": "The pagination token that indicates the next set of results to retrieve.
", - "Service$ServiceCode": "The code for the AWS service.
" + "Service$ServiceCode": "The code for the Amazon Web Services service.
" } }, "errorMessage": { diff --git a/models/apis/pricing/2017-10-15/examples-1.json b/models/apis/pricing/2017-10-15/examples-1.json index abc1c59f342..2a1be6c9153 100644 --- a/models/apis/pricing/2017-10-15/examples-1.json +++ b/models/apis/pricing/2017-10-15/examples-1.json @@ -63,42 +63,6 @@ "id": "to-retreive-attribute-values", "title": "To retrieve a list of attribute values" } - ], - "GetProducts": [ - { - "input": { - "Filters": [ - { - "Field": "ServiceCode", - "Type": "TERM_MATCH", - "Value": "AmazonEC2" - }, - { - "Field": "volumeType", - "Type": "TERM_MATCH", - "Value": "Provisioned IOPS" - } - ], - "FormatVersion": "aws_v1", - "MaxResults": 1 - }, - "output": { - "FormatVersion": "aws_v1", - "NextToken": "57r3EXAMPLEujbzWfHF7Ciw==:ywSmZsD3mtpQmQLQ5XfOsIMkYybSj+vAT+kGmwMFq+K9DGmIoJkz7lunVeamiOPgthdWSO2a7YKojCO+zY4dJmuNl2QvbNhXs+AJ2Ufn7xGmJncNI2TsEuAsVCUfTAvAQNcwwamtk6XuZ4YdNnooV62FjkV3ZAn40d9+wAxV7+FImvhUHi/+f8afgZdGh2zPUlH8jlV9uUtj0oHp8+DhPUuHXh+WBII1E/aoKpPSm3c=", - "PriceList": [ - "{\"product\":{\"productFamily\":\"Storage\",\"attributes\":{\"storageMedia\":\"SSD-backed\",\"maxThroughputvolume\":\"320 MB/sec\",\"volumeType\":\"Provisioned IOPS\",\"maxIopsvolume\":\"20000\",\"servicecode\":\"AmazonEC2\",\"usagetype\":\"CAN1-EBS:VolumeUsage.piops\",\"locationType\":\"AWS Region\",\"location\":\"Canada (Central)\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"maxVolumeSize\":\"16 TiB\",\"operation\":\"\"},\"sku\":\"WQGC34PB2AWS8R4U\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"WQGC34PB2AWS8R4U.JRTCKXETXF\":{\"priceDimensions\":{\"WQGC34PB2AWS8R4U.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"GB-Mo\",\"endRange\":\"Inf\",\"description\":\"$0.138 per GB-month of Provisioned IOPS SSD (io1) provisioned storage - Canada (Central)\",\"appliesTo\":[],\"rateCode\":\"WQGC34PB2AWS8R4U.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.1380000000\"}}},\"sku\":\"WQGC34PB2AWS8R4U\",\"effectiveDate\":\"2017-08-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20170901182201\",\"publicationDate\":\"2017-09-01T18:22:01Z\"}" - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This operation returns a list of products that match the given criteria.", - "id": "to-retrieve-available products", - "title": "To retrieve a list of products" - } ] } } diff --git a/models/apis/redshift/2012-12-01/api-2.json b/models/apis/redshift/2012-12-01/api-2.json index c2b0cc7e8c2..06e72dd9480 100644 --- a/models/apis/redshift/2012-12-01/api-2.json +++ b/models/apis/redshift/2012-12-01/api-2.json @@ -175,6 +175,23 @@ {"shape":"InvalidRetentionPeriodFault"} ] }, + "CreateAuthenticationProfile":{ + "name":"CreateAuthenticationProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAuthenticationProfileMessage"}, + "output":{ + "shape":"CreateAuthenticationProfileResult", + "resultWrapper":"CreateAuthenticationProfileResult" + }, + "errors":[ + {"shape":"AuthenticationProfileAlreadyExistsFault"}, + {"shape":"AuthenticationProfileQuotaExceededFault"}, + {"shape":"InvalidAuthenticationProfileRequestFault"} + ] + }, "CreateCluster":{ "name":"CreateCluster", "http":{ @@ -470,6 +487,22 @@ {"shape":"UnsupportedOperationFault"} ] }, + "DeleteAuthenticationProfile":{ + "name":"DeleteAuthenticationProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAuthenticationProfileMessage"}, + "output":{ + "shape":"DeleteAuthenticationProfileResult", + "resultWrapper":"DeleteAuthenticationProfileResult" + }, + "errors":[ + {"shape":"AuthenticationProfileNotFoundFault"}, + {"shape":"InvalidAuthenticationProfileRequestFault"} + ] + }, "DeleteCluster":{ "name":"DeleteCluster", "http":{ @@ -686,6 +719,22 @@ "resultWrapper":"DescribeAccountAttributesResult" } }, + "DescribeAuthenticationProfiles":{ + "name":"DescribeAuthenticationProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAuthenticationProfilesMessage"}, + "output":{ + "shape":"DescribeAuthenticationProfilesResult", + "resultWrapper":"DescribeAuthenticationProfilesResult" + }, + "errors":[ + {"shape":"AuthenticationProfileNotFoundFault"}, + {"shape":"InvalidAuthenticationProfileRequestFault"} + ] + }, "DescribeClusterDbRevisions":{ "name":"DescribeClusterDbRevisions", "http":{ @@ -1288,6 +1337,23 @@ {"shape":"UnsupportedOperationFault"} ] }, + "ModifyAuthenticationProfile":{ + "name":"ModifyAuthenticationProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyAuthenticationProfileMessage"}, + "output":{ + "shape":"ModifyAuthenticationProfileResult", + "resultWrapper":"ModifyAuthenticationProfileResult" + }, + "errors":[ + {"shape":"AuthenticationProfileNotFoundFault"}, + {"shape":"AuthenticationProfileQuotaExceededFault"}, + {"shape":"InvalidAuthenticationProfileRequestFault"} + ] + }, "ModifyCluster":{ "name":"ModifyCluster", "http":{ @@ -1939,6 +2005,55 @@ "AttributeValue":{"shape":"String"} } }, + "AuthenticationProfile":{ + "type":"structure", + "members":{ + "AuthenticationProfileName":{"shape":"AuthenticationProfileNameString"}, + "AuthenticationProfileContent":{"shape":"String"} + } + }, + "AuthenticationProfileAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthenticationProfileAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthenticationProfileList":{ + "type":"list", + "member":{"shape":"AuthenticationProfile"} + }, + "AuthenticationProfileNameString":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9\\-]+$" + }, + "AuthenticationProfileNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthenticationProfileNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "AuthenticationProfileQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthenticationProfileQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "AuthorizationAlreadyExistsFault":{ "type":"structure", "members":{ @@ -2635,6 +2750,24 @@ }, "exception":true }, + "CreateAuthenticationProfileMessage":{ + "type":"structure", + "required":[ + "AuthenticationProfileName", + "AuthenticationProfileContent" + ], + "members":{ + "AuthenticationProfileName":{"shape":"AuthenticationProfileNameString"}, + "AuthenticationProfileContent":{"shape":"String"} + } + }, + "CreateAuthenticationProfileResult":{ + "type":"structure", + "members":{ + "AuthenticationProfileName":{"shape":"AuthenticationProfileNameString"}, + "AuthenticationProfileContent":{"shape":"String"} + } + }, "CreateClusterMessage":{ "type":"structure", "required":[ @@ -2961,6 +3094,19 @@ "locationName":"DeferredMaintenanceWindow" } }, + "DeleteAuthenticationProfileMessage":{ + "type":"structure", + "required":["AuthenticationProfileName"], + "members":{ + "AuthenticationProfileName":{"shape":"AuthenticationProfileNameString"} + } + }, + "DeleteAuthenticationProfileResult":{ + "type":"structure", + "members":{ + "AuthenticationProfileName":{"shape":"AuthenticationProfileNameString"} + } + }, "DeleteClusterMessage":{ "type":"structure", "required":["ClusterIdentifier"], @@ -3114,6 +3260,18 @@ "AttributeNames":{"shape":"AttributeNameList"} } }, + "DescribeAuthenticationProfilesMessage":{ + "type":"structure", + "members":{ + "AuthenticationProfileName":{"shape":"AuthenticationProfileNameString"} + } + }, + "DescribeAuthenticationProfilesResult":{ + "type":"structure", + "members":{ + "AuthenticationProfiles":{"shape":"AuthenticationProfileList"} + } + }, "DescribeClusterDbRevisionsMessage":{ "type":"structure", "members":{ @@ -4003,6 +4161,17 @@ }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, + "InvalidAuthenticationProfileRequestFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidAuthenticationProfileRequestFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "InvalidAuthorizationStateFault":{ "type":"structure", "members":{ @@ -4353,6 +4522,24 @@ "AquaConfiguration":{"shape":"AquaConfiguration"} } }, + "ModifyAuthenticationProfileMessage":{ + "type":"structure", + "required":[ + "AuthenticationProfileName", + "AuthenticationProfileContent" + ], + "members":{ + "AuthenticationProfileName":{"shape":"AuthenticationProfileNameString"}, + "AuthenticationProfileContent":{"shape":"String"} + } + }, + "ModifyAuthenticationProfileResult":{ + "type":"structure", + "members":{ + "AuthenticationProfileName":{"shape":"AuthenticationProfileNameString"}, + "AuthenticationProfileContent":{"shape":"String"} + } + }, "ModifyClusterDbRevisionMessage":{ "type":"structure", "required":[ diff --git a/models/apis/redshift/2012-12-01/docs-2.json b/models/apis/redshift/2012-12-01/docs-2.json index 6fbdc0c6673..4904f5c957a 100644 --- a/models/apis/redshift/2012-12-01/docs-2.json +++ b/models/apis/redshift/2012-12-01/docs-2.json @@ -4,27 +4,29 @@ "operations": { "AcceptReservedNodeExchange": "Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.
", "AddPartner": "Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website.
", - "AuthorizeClusterSecurityGroupIngress": "Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
", + "AuthorizeClusterSecurityGroupIngress": "Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same Region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
", "AuthorizeEndpointAccess": "Grants access to a cluster.
", - "AuthorizeSnapshotAccess": "Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", + "AuthorizeSnapshotAccess": "Authorizes the specified account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", "BatchDeleteClusterSnapshots": "Deletes a set of cluster snapshots.
", "BatchModifyClusterSnapshots": "Modifies the settings for a set of cluster snapshots.
", "CancelResize": "Cancels a resize operation for a cluster.
", "CopyClusterSnapshot": "Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", + "CreateAuthenticationProfile": "Creates an authentication profile with the specified parameters.
", "CreateCluster": "Creates a new cluster with the specified parameters.
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
", "CreateClusterParameterGroup": "Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
", "CreateClusterSecurityGroup": "Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
", "CreateClusterSnapshot": "Creates a manual snapshot of the specified cluster. The cluster must be in the available state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", "CreateClusterSubnetGroup": "Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
", "CreateEndpointAccess": "Creates a Redshift-managed VPC endpoint.
", - "CreateEventSubscription": "Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.
", + "CreateEventSubscription": "Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your account. You must specify a source type if you specify a source ID.
", "CreateHsmClientCertificate": "Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
", "CreateHsmConfiguration": "Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
", "CreateScheduledAction": "Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", + "CreateSnapshotCopyGrant": "Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from Key Management Service (KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", "CreateSnapshotSchedule": "Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
", "CreateTags": "Adds tags to a cluster.
A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
", "CreateUsageLimit": "Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
", + "DeleteAuthenticationProfile": "Deletes an authentication profile.
", "DeleteCluster": "Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be \"final-snapshot\" while the snapshot is being taken, then it's \"deleting\" once Amazon Redshift begins deleting the cluster.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
", "DeleteClusterParameterGroup": "Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
Deletes an Amazon Redshift security group.
You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
", @@ -41,12 +43,13 @@ "DeleteTags": "Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
", "DeleteUsageLimit": "Deletes a usage limit from a cluster.
", "DescribeAccountAttributes": "Returns a list of attributes attached to an account
", + "DescribeAuthenticationProfiles": "Describes an authentication profile.
", "DescribeClusterDbRevisions": "Returns an array of ClusterDbRevision objects.
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
", "DescribeClusterParameters": "Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
", "DescribeClusterSecurityGroups": "Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
", - "DescribeClusterSnapshots": "Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
", - "DescribeClusterSubnetGroups": "Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeClusterSnapshots": "Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your account. No information is returned for snapshots owned by inactive accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeClusterSubnetGroups": "Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
", "DescribeClusterTracks": "Returns a list of all the available maintenance tracks.
", "DescribeClusterVersions": "Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
", "DescribeClusters": "Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
", @@ -56,32 +59,33 @@ "DescribeEventCategories": "Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
", "DescribeEventSubscriptions": "Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
", "DescribeEvents": "Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
", - "DescribeHsmClientCertificates": "Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
", - "DescribeHsmConfigurations": "Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeHsmClientCertificates": "Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeHsmConfigurations": "Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
", "DescribeLoggingStatus": "Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
", "DescribeNodeConfigurationOptions": "Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
", - "DescribeOrderableClusterOptions": "Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
", + "DescribeOrderableClusterOptions": "Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
", "DescribePartners": "Returns information about the partner integrations defined for a cluster.
", "DescribeReservedNodeOfferings": "Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
", "DescribeReservedNodes": "Returns the descriptions of the reserved nodes.
", "DescribeResize": "Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
", "DescribeScheduledActions": "Describes properties of scheduled actions.
", - "DescribeSnapshotCopyGrants": "Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", + "DescribeSnapshotCopyGrants": "Returns a list of snapshot copy grants owned by the account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", "DescribeSnapshotSchedules": "Returns a list of snapshot schedules.
", "DescribeStorage": "Returns account level backups storage size and provisional storage.
", "DescribeTableRestoreStatus": "Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
", "DescribeUsageLimits": "Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:
If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned.
If usage limit identifier is provided, then the corresponding usage limit object is returned.
If cluster identifier is provided, then all usage limit objects for the specified cluster are returned.
If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
", - "DisableSnapshotCopy": "Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
", + "DisableSnapshotCopy": "Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from Key Management Service, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
", "EnableLogging": "Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
", "EnableSnapshotCopy": "Enables the automatic copy of snapshots from one region to another region for a specified cluster.
", - "GetClusterCredentials": "Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups.
In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege.
If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups.
In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege.
If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
", "ModifyAquaConfiguration": "Modifies whether a cluster can use AQUA (Advanced Query Accelerator).
", - "ModifyCluster": "Modifies the settings for a cluster.
You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.
You can add another security or parameter group, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
", + "ModifyAuthenticationProfile": "Modifies an authentication profile.
", + "ModifyCluster": "Modifies the settings for a cluster.
You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.
You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
", "ModifyClusterDbRevision": "Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
", - "ModifyClusterIamRoles": "Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
A cluster can have up to 10 IAM roles associated at any time.
", + "ModifyClusterIamRoles": "Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
A cluster can have up to 10 IAM roles associated at any time.
", "ModifyClusterMaintenance": "Modifies the maintenance settings of a cluster.
", "ModifyClusterParameterGroup": "Modifies the parameters of a parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
", "ModifyClusterSnapshot": "Modifies the settings for a snapshot.
This exanmple modifies the manual retention period setting for a cluster snapshot.
", @@ -90,7 +94,7 @@ "ModifyEndpointAccess": "Modifies a Redshift-managed VPC endpoint.
", "ModifyEventSubscription": "Modifies an existing Amazon Redshift event notification subscription.
", "ModifyScheduledAction": "Modifies a scheduled action.
", - "ModifySnapshotCopyRetentionPeriod": "Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.
", + "ModifySnapshotCopyRetentionPeriod": "Modifies the number of days to retain snapshots in the destination Region after they are copied from the source Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.
", "ModifySnapshotSchedule": "Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
", "ModifyUsageLimit": "Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.
", "PauseCluster": "Pauses a cluster.
", @@ -103,7 +107,7 @@ "ResumeCluster": "Resumes a paused cluster.
", "RevokeClusterSecurityGroupIngress": "Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
", "RevokeEndpointAccess": "Revokes access to a cluster.
", - "RevokeSnapshotAccess": "Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", + "RevokeSnapshotAccess": "Removes the ability of the specified account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", "RotateEncryptionKey": "Rotates the encryption keys for a cluster.
", "UpdatePartnerStatus": "Updates the status of a partner integration.
" }, @@ -140,7 +144,7 @@ } }, "AccountWithRestoreAccess": { - "base": "Describes an AWS customer account authorized to restore a snapshot.
", + "base": "Describes an account authorized to restore a snapshot.
", "refs": { "AccountsWithRestoreAccessList$member": null } @@ -148,7 +152,7 @@ "AccountsWithRestoreAccessList": { "base": null, "refs": { - "Snapshot$AccountsWithRestoreAccess": "A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
A list of the accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
The value represents how the cluster is configured to use AQUA. Possible values include the following.
enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.
enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
The new value of AQUA configuration status. Possible values include the following.
enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.
enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
The value represents how the cluster is configured to use AQUA. Possible values include the following.
enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.
enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
The new value of AQUA configuration status. Possible values include the following.
enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.
enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
Describes an authentication profile.
", + "refs": { + "AuthenticationProfileList$member": null + } + }, + "AuthenticationProfileAlreadyExistsFault": { + "base": "The authentication profile already exists.
", + "refs": { + } + }, + "AuthenticationProfileList": { + "base": null, + "refs": { + "DescribeAuthenticationProfilesResult$AuthenticationProfiles": "The list of authentication profiles.
" + } + }, + "AuthenticationProfileNameString": { + "base": null, + "refs": { + "AuthenticationProfile$AuthenticationProfileName": "The name of the authentication profile.
", + "CreateAuthenticationProfileMessage$AuthenticationProfileName": "The name of the authentication profile to be created.
", + "CreateAuthenticationProfileResult$AuthenticationProfileName": "The name of the authentication profile that was created.
", + "DeleteAuthenticationProfileMessage$AuthenticationProfileName": "The name of the authentication profile to delete.
", + "DeleteAuthenticationProfileResult$AuthenticationProfileName": "The name of the authentication profile that was deleted.
", + "DescribeAuthenticationProfilesMessage$AuthenticationProfileName": "The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.
", + "ModifyAuthenticationProfileMessage$AuthenticationProfileName": "The name of the authentication profile to replace.
", + "ModifyAuthenticationProfileResult$AuthenticationProfileName": "The name of the authentication profile that was replaced.
" + } + }, + "AuthenticationProfileNotFoundFault": { + "base": "The authentication profile can't be found.
", + "refs": { + } + }, + "AuthenticationProfileQuotaExceededFault": { + "base": "The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.
", + "refs": { + } + }, "AuthorizationAlreadyExistsFault": { "base": "The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
", "refs": { @@ -432,7 +476,7 @@ } }, "ClusterIamRole": { - "base": "An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.
", + "base": "An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
", "refs": { "ClusterIamRoleList$member": null } @@ -440,7 +484,7 @@ "ClusterIamRoleList": { "base": null, "refs": { - "Cluster$IamRoles": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
" + "Cluster$IamRoles": "A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
" } }, "ClusterList": { @@ -689,6 +733,16 @@ "refs": { } }, + "CreateAuthenticationProfileMessage": { + "base": null, + "refs": { + } + }, + "CreateAuthenticationProfileResult": { + "base": null, + "refs": { + } + }, "CreateClusterMessage": { "base": "", "refs": { @@ -839,6 +893,16 @@ "Cluster$DeferredMaintenanceWindows": "Describes a group of DeferredMaintenanceWindow objects.
Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
", + "base": "Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across accounts.
", "refs": { "EndpointAuthorizations$member": null } @@ -1443,10 +1517,10 @@ "IamRoleArnList": { "base": null, "refs": { - "CreateClusterMessage$IamRoles": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
", + "CreateClusterMessage$IamRoles": "A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
", "ModifyClusterIamRolesMessage$AddIamRoles": "Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
", "ModifyClusterIamRolesMessage$RemoveIamRoles": "Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.
", - "RestoreFromClusterSnapshotMessage$IamRoles": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated at any time.
" + "RestoreFromClusterSnapshotMessage$IamRoles": "A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated at any time.
" } }, "ImportTablesCompleted": { @@ -1497,7 +1571,7 @@ "Endpoint$Port": "The port that the database engine is listening on.
", "EndpointAccess$Port": "The port number on which the cluster accepts incoming connections.
", "EndpointAuthorization$EndpointCount": "The number of Redshift-managed VPC endpoints created for the authorization.
", - "ModifySnapshotCopyRetentionPeriodMessage$RetentionPeriod": "The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
", + "ModifySnapshotCopyRetentionPeriodMessage$RetentionPeriod": "The number of days to retain automated snapshots in the destination Region after they are copied from the source Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
", "NodeConfigurationOption$NumberOfNodes": "The number of nodes.
", "ReservedNode$Duration": "The duration of the node reservation in seconds.
", "ReservedNode$NodeCount": "The number of reserved compute nodes.
", @@ -1546,7 +1620,7 @@ "DescribeTagsMessage$MaxRecords": "The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", "EnableSnapshotCopyMessage$RetentionPeriod": "The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
", - "EnableSnapshotCopyMessage$ManualSnapshotRetentionPeriod": "The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
", + "EnableSnapshotCopyMessage$ManualSnapshotRetentionPeriod": "The number of days to retain newly copied snapshots in the destination Region after they are copied from the source Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
", "GetClusterCredentialsMessage$DurationSeconds": "The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600.
Default: 900
", "GetReservedNodeExchangeOfferingsInputMessage$MaxRecords": "An integer setting the maximum number of ReservedNodeOfferings to retrieve.
", "ModifyClusterMaintenanceMessage$DeferMaintenanceDuration": "An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
", @@ -1569,6 +1643,11 @@ "SnapshotSchedule$AssociatedClusterCount": "The number of clusters associated with the schedule.
" } }, + "InvalidAuthenticationProfileRequestFault": { + "base": "The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Region.
", + "refs": { + } + }, "InvalidAuthorizationStateFault": { "base": "The status of the authorization is not valid.
", "refs": { @@ -1705,7 +1784,7 @@ } }, "LimitExceededFault": { - "base": "The encryption key has exceeded its grant limit in AWS KMS.
", + "base": "The encryption key has exceeded its grant limit in Amazon Web Services KMS.
", "refs": { } }, @@ -1767,6 +1846,16 @@ "refs": { } }, + "ModifyAuthenticationProfileMessage": { + "base": null, + "refs": { + } + }, + "ModifyAuthenticationProfileResult": { + "base": null, + "refs": { + } + }, "ModifyClusterDbRevisionMessage": { "base": null, "refs": { @@ -1987,9 +2076,9 @@ "PartnerIntegrationAccountId": { "base": null, "refs": { - "DescribePartnersInputMessage$AccountId": "The AWS account ID that owns the cluster.
", - "PartnerIntegrationInputMessage$AccountId": "The AWS account ID that owns the cluster.
", - "UpdatePartnerStatusInputMessage$AccountId": "The AWS account ID that owns the cluster.
" + "DescribePartnersInputMessage$AccountId": "The Region ID that owns the cluster.
", + "PartnerIntegrationInputMessage$AccountId": "The Region ID that owns the cluster.
", + "UpdatePartnerStatusInputMessage$AccountId": "The Region ID that owns the cluster.
" } }, "PartnerIntegrationClusterIdentifier": { @@ -2475,7 +2564,7 @@ } }, "SnapshotCopyGrant": { - "base": "The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", + "base": "The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from Amazon Web Services KMS in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", "refs": { "CreateSnapshotCopyGrantResult$SnapshotCopyGrant": null, "SnapshotCopyGrantList$member": null @@ -2503,7 +2592,7 @@ } }, "SnapshotCopyGrantQuotaExceededFault": { - "base": "The AWS account has exceeded the maximum number of snapshot copy grants in this region.
", + "base": "The account has exceeded the maximum number of snapshot copy grants in this region.
", "refs": { } }, @@ -2609,19 +2698,20 @@ "AcceptReservedNodeExchangeInputMessage$ReservedNodeId": "A string representing the node identifier of the DC1 Reserved Node to be exchanged.
", "AcceptReservedNodeExchangeInputMessage$TargetReservedNodeOfferingId": "The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings
", "AccountAttribute$AttributeName": "The name of the attribute.
", - "AccountWithRestoreAccess$AccountId": "The identifier of an AWS customer account authorized to restore a snapshot.
", - "AccountWithRestoreAccess$AccountAlias": "The identifier of an AWS support account authorized to restore a snapshot. For AWS support, the identifier is amazon-redshift-support.
The identifier of an account authorized to restore a snapshot.
", + "AccountWithRestoreAccess$AccountAlias": "The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.
The value of the attribute.
", + "AuthenticationProfile$AuthenticationProfileContent": "The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
", "AuthorizeClusterSecurityGroupIngressMessage$ClusterSecurityGroupName": "The name of the security group to which the ingress rule is added.
", "AuthorizeClusterSecurityGroupIngressMessage$CIDRIP": "The IP range to be added the Amazon Redshift security group.
", "AuthorizeClusterSecurityGroupIngressMessage$EC2SecurityGroupName": "The EC2 security group to be added the Amazon Redshift security group.
", - "AuthorizeClusterSecurityGroupIngressMessage$EC2SecurityGroupOwnerId": "The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333
The account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The Amazon Web Services Access Key ID is not an acceptable value.
Example: 111122223333
The cluster identifier of the cluster to grant access to.
", - "AuthorizeEndpointAccessMessage$Account": "The AWS account ID to grant access to.
", + "AuthorizeEndpointAccessMessage$Account": "The account ID to grant access to.
", "AuthorizeSnapshotAccessMessage$SnapshotIdentifier": "The identifier of the snapshot the account is authorized to restore.
", "AuthorizeSnapshotAccessMessage$SnapshotClusterIdentifier": "The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
", - "AuthorizeSnapshotAccessMessage$AccountWithRestoreAccess": "The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.
", + "AuthorizeSnapshotAccessMessage$AccountWithRestoreAccess": "The identifier of the account authorized to restore the specified snapshot.
To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.
", "AvailabilityZone$Name": "The name of the availability zone.
", "CancelResizeMessage$ClusterIdentifier": "The unique identifier for the cluster that you want to cancel a resize operation for.
", "Cluster$ClusterIdentifier": "The unique identifier of the cluster.
", @@ -2629,7 +2719,7 @@ "Cluster$ClusterStatus": "The current state of the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
The status of a modify operation, if any, initiated for the cluster.
", - "Cluster$MasterUsername": "The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
", + "Cluster$MasterUsername": "The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
", "Cluster$DBName": "The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
", "Cluster$VpcId": "The identifier of the VPC the cluster is in, if the cluster is in a VPC.
", @@ -2638,7 +2728,7 @@ "Cluster$ClusterVersion": "The version ID of the Amazon Redshift engine that is running on the cluster.
", "Cluster$ClusterPublicKey": "The public key for the cluster.
", "Cluster$ClusterRevisionNumber": "The specific revision number of the database in the cluster.
", - "Cluster$KmsKeyId": "The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
", + "Cluster$KmsKeyId": "The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
", "Cluster$MaintenanceTrackName": "The name of the maintenance track for the cluster.
", "Cluster$ElasticResizeNumberOfNodeOptions": "The number of nodes that you can resize the cluster to with the elastic resize method.
", "Cluster$SnapshotScheduleIdentifier": "A unique identifier for the cluster snapshot schedule.
", @@ -2687,13 +2777,15 @@ "ClustersMessage$Marker": "A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.
The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
Must be the identifier for a valid cluster.
The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the account that is making the request.
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
", + "CreateAuthenticationProfileResult$AuthenticationProfileContent": "The content of the authentication profile in JSON format.
", "CreateClusterMessage$DBName": "The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
Must contain 1 to 64 alphanumeric characters.
Must contain only lowercase letters.
Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an account.
Example: myexamplecluster
The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.
The user name associated with the admin user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
The password associated with the admin user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.
The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
", "CreateClusterMessage$AvailabilityZone": "The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
", "CreateClusterMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
", @@ -2702,26 +2794,26 @@ "CreateClusterMessage$HsmClientCertificateIdentifier": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
", "CreateClusterMessage$HsmConfigurationIdentifier": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
", "CreateClusterMessage$ElasticIp": "The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
", - "CreateClusterMessage$KmsKeyId": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
", + "CreateClusterMessage$KmsKeyId": "The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
", "CreateClusterMessage$AdditionalInfo": "Reserved.
", "CreateClusterMessage$MaintenanceTrackName": "An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.
A unique identifier for the snapshot schedule.
", - "CreateClusterParameterGroupMessage$ParameterGroupName": "The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
This value is stored as a lower-case string.
The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is \"redshift-1.0\".
", + "CreateClusterParameterGroupMessage$ParameterGroupName": "The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your account.
This value is stored as a lower-case string.
The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is \"redshift-1.0\".
", "CreateClusterParameterGroupMessage$Description": "A description of the parameter group.
", - "CreateClusterSecurityGroupMessage$ClusterSecurityGroupName": "The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be \"Default\".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup
The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be \"Default\".
Must be unique for all security groups that are created by your account.
Example: examplesecuritygroup
A description for the security group.
", - "CreateClusterSnapshotMessage$SnapshotIdentifier": "A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The cluster identifier for which you want a snapshot.
", - "CreateClusterSubnetGroupMessage$ClusterSubnetGroupName": "The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be \"Default\".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup
The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be \"Default\".
Must be unique for all subnet groups that are created by your account.
Example: examplesubnetgroup
A description for the subnet group.
", "CreateEndpointAccessMessage$ClusterIdentifier": "The cluster identifier of the cluster to access.
", - "CreateEndpointAccessMessage$ResourceOwner": "The AWS account ID of the owner of the cluster. This is only required if the cluster is in another AWS account.
", + "CreateEndpointAccessMessage$ResourceOwner": "The account ID of the owner of the cluster. This is only required if the cluster is in another account.
", "CreateEndpointAccessMessage$EndpointName": "The Redshift-managed VPC endpoint name.
An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
", "CreateEndpointAccessMessage$SubnetGroupName": "The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
", "CreateEventSubscriptionMessage$SubscriptionName": "The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", - "CreateEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
", + "CreateEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
", "CreateEventSubscriptionMessage$Severity": "Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
", "CreateHsmClientCertificateMessage$HsmClientCertificateIdentifier": "The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.
", "CreateHsmConfigurationMessage$HsmConfigurationIdentifier": "The identifier to be assigned to the new Amazon Redshift HSM configuration.
", @@ -2734,7 +2826,7 @@ "CreateScheduledActionMessage$Schedule": "The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
", "CreateScheduledActionMessage$ScheduledActionDescription": "The description of the scheduled action.
", - "CreateSnapshotCopyGrantMessage$SnapshotCopyGrantName": "The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
The name of the snapshot copy grant. This name must be unique in the region for the account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an account.
The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
", "CreateSnapshotScheduleMessage$ScheduleIdentifier": "A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
", "CreateSnapshotScheduleMessage$ScheduleDescription": "The description of the snapshot schedule.
", @@ -2764,62 +2856,62 @@ "DescribeClusterDbRevisionsMessage$ClusterIdentifier": "A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
", - "DescribeClusterParameterGroupsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The name of a cluster parameter group for which to return details.
", "DescribeClusterParametersMessage$Source": "The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
", + "DescribeClusterSecurityGroupsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
", "DescribeClusterSnapshotsMessage$ClusterIdentifier": "The identifier of the cluster which generated the requested snapshots.
", "DescribeClusterSnapshotsMessage$SnapshotIdentifier": "The snapshot identifier of the snapshot about which to return information.
", "DescribeClusterSnapshotsMessage$SnapshotType": "The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.
Valid Values: automated | manual
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.
", + "DescribeClusterSnapshotsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your account, or do not specify the parameter.
", "DescribeClusterSubnetGroupsMessage$ClusterSubnetGroupName": "The name of the cluster subnet group for which information is requested.
", - "DescribeClusterSubnetGroupsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The name of the maintenance track.
", "DescribeClusterTracksMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The specific cluster version to return.
Example: 1.0
The name of a specific cluster parameter group family to return details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
", - "DescribeClustersMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
", + "DescribeClustersMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
", "DescribeDefaultClusterParametersMessage$ParameterGroupFamily": "The name of the cluster parameter group family.
", - "DescribeDefaultClusterParametersMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The cluster identifier associated with the described endpoint.
", - "DescribeEndpointAccessMessage$ResourceOwner": "The AWS account ID of the owner of the cluster.
", + "DescribeEndpointAccessMessage$ResourceOwner": "The account ID of the owner of the cluster.
", "DescribeEndpointAccessMessage$EndpointName": "The name of the endpoint to be described.
", "DescribeEndpointAccessMessage$VpcId": "The virtual private cloud (VPC) identifier with access to the cluster.
", "DescribeEndpointAccessMessage$Marker": "An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
The cluster identifier of the cluster to access.
", - "DescribeEndpointAuthorizationMessage$Account": "The AWS account ID of either the cluster owner (grantor) or grantee. If Grantee parameter is true, then the Account value is of the grantor.
The Aaccount ID of either the cluster owner (grantor) or grantee. If Grantee parameter is true, then the Account value is of the grantor.
An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.
", "DescribeEventSubscriptionsMessage$SubscriptionName": "The name of the Amazon Redshift event notification subscription to be described.
", - "DescribeEventSubscriptionsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.
", - "DescribeHsmClientCertificatesMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
", - "DescribeHsmConfigurationsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your account.
", + "DescribeHsmClientCertificatesMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your account.
", + "DescribeHsmConfigurationsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of the cluster from which to get the logging status.
Example: examplecluster
The identifier of the cluster to evaluate for possible node configurations.
", "DescribeNodeConfigurationOptionsMessage$SnapshotIdentifier": "The identifier of the snapshot to evaluate for possible node configurations.
", - "DescribeNodeConfigurationOptionsMessage$OwnerAccount": "The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
", - "DescribeNodeConfigurationOptionsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
", + "DescribeNodeConfigurationOptionsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
", "DescribeOrderableClusterOptionsMessage$NodeType": "The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
", - "DescribeOrderableClusterOptionsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The unique identifier for the offering.
", - "DescribeReservedNodeOfferingsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Identifier for the node reservation.
", - "DescribeReservedNodesMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.
", + "DescribeReservedNodesMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an account are returned.
", "DescribeScheduledActionsMessage$ScheduledActionName": "The name of the scheduled action to retrieve.
", - "DescribeScheduledActionsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The name of the snapshot copy grant.
", - "DescribeSnapshotCopyGrantsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
", + "DescribeSnapshotCopyGrantsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
", "DescribeSnapshotSchedulesMessage$ClusterIdentifier": "The unique identifier for the cluster whose snapshot schedules you want to view.
", "DescribeSnapshotSchedulesMessage$ScheduleIdentifier": "A unique identifier for a snapshot schedule.
", "DescribeSnapshotSchedulesMessage$Marker": "A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
The identifier of the usage limit to describe.
", "DescribeUsageLimitsMessage$ClusterIdentifier": "The identifier of the cluster for which you want to describe usage limits.
", - "DescribeUsageLimitsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
", "EC2SecurityGroup$Status": "The status of the EC2 security group.
", "EC2SecurityGroup$EC2SecurityGroupName": "The name of the EC2 Security Group.
", - "EC2SecurityGroup$EC2SecurityGroupOwnerId": "The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
The account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
The elastic IP (EIP) address for the cluster.
", "ElasticIpStatus$Status": "The status of the elastic IP (EIP) address.
", "EnableLoggingMessage$ClusterIdentifier": "The identifier of the cluster on which logging is to be started.
Example: examplecluster
The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes (\"), single quotes ('), a backslash (\\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger
The unique identifier of the source cluster to copy snapshots from.
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
", - "EnableSnapshotCopyMessage$DestinationRegion": "The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
", - "EnableSnapshotCopyMessage$SnapshotCopyGrantName": "The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
", + "EnableSnapshotCopyMessage$DestinationRegion": "The destination Region that you want to copy snapshots to.
Constraints: Must be the name of a valid Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
", + "EnableSnapshotCopyMessage$SnapshotCopyGrantName": "The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
", "Endpoint$Address": "The DNS address of the Cluster.
", "EndpointAccess$ClusterIdentifier": "The cluster identifier of the cluster associated with the endpoint.
", - "EndpointAccess$ResourceOwner": "The AWS account ID of the owner of the cluster.
", + "EndpointAccess$ResourceOwner": "The account ID of the owner of the cluster.
", "EndpointAccess$SubnetGroupName": "The subnet group name where Amazon Redshift chooses to deploy the endpoint.
", "EndpointAccess$EndpointStatus": "The status of the endpoint.
", "EndpointAccess$EndpointName": "The name of the endpoint.
", "EndpointAccess$Address": "The DNS address of the endpoint.
", "EndpointAccessList$Marker": "An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
The AWS account ID of the cluster owner.
", - "EndpointAuthorization$Grantee": "The AWS account ID of the grantee of the cluster.
", + "EndpointAuthorization$Grantor": "The account ID of the cluster owner.
", + "EndpointAuthorization$Grantee": "The account ID of the grantee of the cluster.
", "EndpointAuthorization$ClusterIdentifier": "The cluster identifier.
", "EndpointAuthorization$ClusterStatus": "The status of the cluster.
", "EndpointAuthorizationList$Marker": "An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
The identifier of an Amazon Redshift event.
", "EventInfoMap$EventDescription": "The description of an Amazon Redshift event.
", "EventInfoMap$Severity": "The severity of the event.
Values: ERROR, INFO
", - "EventSubscription$CustomerAwsId": "The AWS customer account associated with the Amazon Redshift event notification subscription.
", + "EventSubscription$CustomerAwsId": "The account associated with the Amazon Redshift event notification subscription.
", "EventSubscription$CustSubscriptionId": "The name of the Amazon Redshift event notification subscription.
", "EventSubscription$SnsTopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
", "EventSubscription$Status": "The status of the Amazon Redshift event notification subscription.
Constraints:
Can be one of the following: active | no-permission | topic-not-exist
The status \"no-permission\" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
The name of the maintenance track. Possible values are current and trailing.
The version number for the cluster release.
", "ModifyAquaInputMessage$ClusterIdentifier": "The identifier of the cluster to be modified.
", + "ModifyAuthenticationProfileMessage$AuthenticationProfileContent": "The new content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
", + "ModifyAuthenticationProfileResult$AuthenticationProfileContent": "The updated content of the authentication profile in JSON format.
", "ModifyClusterDbRevisionMessage$ClusterIdentifier": "The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
", "ModifyClusterIamRolesMessage$ClusterIdentifier": "The unique identifier of the cluster for which you want to associate or disassociate IAM roles.
", @@ -2913,16 +3007,16 @@ "ModifyClusterMessage$ClusterIdentifier": "The unique identifier of the cluster to be modified.
Example: examplecluster
The new cluster type.
When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.
Valid Values: multi-node | single-node
The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.
Default: Uses existing setting.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.
The new password for the cluster admin user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost.
Default: Uses existing setting.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.
The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
", "ModifyClusterMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.
This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
", "ModifyClusterMessage$ClusterVersion": "The new version number of the Amazon Redshift engine to upgrade to.
For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
", "ModifyClusterMessage$HsmConfigurationIdentifier": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
", - "ModifyClusterMessage$NewClusterIdentifier": "The new identifier for the cluster.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: examplecluster
The new identifier for the cluster.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an account.
Example: examplecluster
The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
", "ModifyClusterMessage$MaintenanceTrackName": "The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
", + "ModifyClusterMessage$KmsKeyId": "The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
", "ModifyClusterMessage$AvailabilityZone": "The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
", "ModifyClusterParameterGroupMessage$ParameterGroupName": "The name of the parameter group to be modified.
", "ModifyClusterSnapshotMessage$SnapshotIdentifier": "The identifier of the snapshot whose setting you want to modify.
", @@ -2933,13 +3027,13 @@ "ModifyEndpointAccessMessage$EndpointName": "The endpoint to be modified.
", "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the modified Amazon Redshift event notification subscription.
", "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.
", - "ModifyEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
", + "ModifyEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
", "ModifyEventSubscriptionMessage$Severity": "Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
", "ModifyScheduledActionMessage$ScheduledActionName": "The name of the scheduled action to modify.
", "ModifyScheduledActionMessage$Schedule": "A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
", "ModifyScheduledActionMessage$ScheduledActionDescription": "A modified description of the scheduled action.
", - "ModifySnapshotCopyRetentionPeriodMessage$ClusterIdentifier": "The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
", + "ModifySnapshotCopyRetentionPeriodMessage$ClusterIdentifier": "The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
", "ModifySnapshotScheduleMessage$ScheduleIdentifier": "A unique alphanumeric identifier of the schedule to modify.
", "ModifyUsageLimitMessage$UsageLimitId": "The identifier of the usage limit to modify.
", "NetworkInterface$NetworkInterfaceId": "The network interface identifier.
", @@ -2961,7 +3055,7 @@ "Parameter$MinimumEngineVersion": "The earliest engine version to which the parameter can apply.
", "PauseClusterMessage$ClusterIdentifier": "The identifier of the cluster to be paused.
", "PendingActionsList$member": null, - "PendingModifiedValues$MasterUserPassword": "The pending or in-progress change of the master user password for the cluster.
", + "PendingModifiedValues$MasterUserPassword": "The pending or in-progress change of the admin user password for the cluster.
", "PendingModifiedValues$NodeType": "The pending or in-progress change of the cluster's node type.
", "PendingModifiedValues$ClusterType": "The pending or in-progress change of the cluster type.
", "PendingModifiedValues$ClusterVersion": "The pending or in-progress change of the service version.
", @@ -2995,18 +3089,18 @@ "ResizeProgressMessage$Message": "An optional string to provide additional details about the resize action.
", "ResizeProgressMessage$TargetEncryptionType": "The type of encryption for the cluster after the resize is complete.
Possible values are KMS and None.
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an account.
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
", "RestoreFromClusterSnapshotMessage$AvailabilityZone": "The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
The name of the subnet group where you want to cluster restored.
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
", - "RestoreFromClusterSnapshotMessage$OwnerAccount": "The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
", + "RestoreFromClusterSnapshotMessage$OwnerAccount": "The account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
", "RestoreFromClusterSnapshotMessage$HsmClientCertificateIdentifier": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
", "RestoreFromClusterSnapshotMessage$HsmConfigurationIdentifier": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
", "RestoreFromClusterSnapshotMessage$ElasticIp": "The elastic IP (EIP) address for the cluster.
", "RestoreFromClusterSnapshotMessage$ClusterParameterGroupName": "The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
", - "RestoreFromClusterSnapshotMessage$KmsKeyId": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
", + "RestoreFromClusterSnapshotMessage$KmsKeyId": "The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
", "RestoreFromClusterSnapshotMessage$NodeType": "The node type that the restored cluster will be provisioned with.
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
", "RestoreFromClusterSnapshotMessage$AdditionalInfo": "Reserved.
", "RestoreFromClusterSnapshotMessage$MaintenanceTrackName": "The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.
The name of the security Group from which to revoke the ingress rule.
", "RevokeClusterSecurityGroupIngressMessage$CIDRIP": "The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.
The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333
The account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333
The cluster to revoke access from.
", - "RevokeEndpointAccessMessage$Account": "The AWS account ID whose access is to be revoked.
", + "RevokeEndpointAccessMessage$Account": "The account ID whose access is to be revoked.
", "RevokeSnapshotAccessMessage$SnapshotIdentifier": "The identifier of the snapshot that the account can no longer access.
", "RevokeSnapshotAccessMessage$SnapshotClusterIdentifier": "The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
", - "RevokeSnapshotAccessMessage$AccountWithRestoreAccess": "The identifier of the AWS customer account that can no longer restore the specified snapshot.
", + "RevokeSnapshotAccessMessage$AccountWithRestoreAccess": "The identifier of the account that can no longer restore the specified snapshot.
", "RotateEncryptionKeyMessage$ClusterIdentifier": "The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.
", "ScheduleDefinitionList$member": null, "ScheduledAction$ScheduledActionName": "The name of the scheduled action.
", "ScheduledAction$Schedule": "The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", "ScheduledAction$ScheduledActionDescription": "The description of the scheduled action.
", - "ScheduledActionsMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The snapshot identifier that is provided in the request.
", "Snapshot$ClusterIdentifier": "The identifier of the cluster for which the snapshot was taken.
", "Snapshot$Status": "The snapshot status. The value of the status depends on the API operation used:
CreateClusterSnapshot and CopyClusterSnapshot returns status as \"creating\".
DescribeClusterSnapshots returns status as \"creating\", \"available\", \"final snapshot\", or \"failed\".
DeleteClusterSnapshot returns status as \"deleted\".
The Availability Zone in which the cluster was created.
", - "Snapshot$MasterUsername": "The master user name for the cluster.
", + "Snapshot$MasterUsername": "The admin user name for the cluster.
", "Snapshot$ClusterVersion": "The version ID of the Amazon Redshift engine that is running on the cluster.
", "Snapshot$EngineFullVersion": "The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
", "Snapshot$SnapshotType": "The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type \"manual\".
", "Snapshot$NodeType": "The node type of the nodes in the cluster.
", "Snapshot$DBName": "The name of the database that was created when the cluster was created.
", "Snapshot$VpcId": "The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
", - "Snapshot$KmsKeyId": "The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
", - "Snapshot$OwnerAccount": "For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
", + "Snapshot$KmsKeyId": "The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
", + "Snapshot$OwnerAccount": "For manual snapshots, the account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
", "Snapshot$SourceRegion": "The source region from which the snapshot was copied.
", "Snapshot$MaintenanceTrackName": "The name of the maintenance track for the snapshot.
", "SnapshotCopyGrant$SnapshotCopyGrantName": "The name of the snapshot copy grant.
", - "SnapshotCopyGrant$KmsKeyId": "The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.
", - "SnapshotCopyGrantMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
", + "SnapshotCopyGrant$KmsKeyId": "The unique identifier of the customer master key (CMK) in Amazon Web Services KMS to which Amazon Redshift is granted permission.
", + "SnapshotCopyGrantMessage$Marker": "An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
", "SnapshotErrorMessage$SnapshotIdentifier": "A unique identifier for the snapshot returning the error.
", "SnapshotErrorMessage$SnapshotClusterIdentifier": "A unique identifier for the cluster.
", "SnapshotErrorMessage$FailureCode": "The failure code for the error.
", diff --git a/models/apis/ssm/2014-11-06/api-2.json b/models/apis/ssm/2014-11-06/api-2.json index f62846c7154..52349ca4e67 100644 --- a/models/apis/ssm/2014-11-06/api-2.json +++ b/models/apis/ssm/2014-11-06/api-2.json @@ -7554,7 +7554,8 @@ "ChangeRequestByApproverArn", "ChangeRequestByApproverName", "ChangeRequestByTemplate", - "ChangeRequestByTargetsResourceGroup" + "ChangeRequestByTargetsResourceGroup", + "InsightByType" ] }, "OpsItemFilterOperator":{ @@ -7752,7 +7753,8 @@ "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", - "Rejected" + "Rejected", + "Closed" ] }, "OpsItemSummaries":{ diff --git a/models/apis/ssm/2014-11-06/docs-2.json b/models/apis/ssm/2014-11-06/docs-2.json index 571d2c6562a..df641a992cb 100644 --- a/models/apis/ssm/2014-11-06/docs-2.json +++ b/models/apis/ssm/2014-11-06/docs-2.json @@ -1,47 +1,47 @@ { "version": "2.0", - "service": "AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the AWS Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Setting up AWS Systems Manager in the AWS Systems Manager User Guide.
Related resources
For information about how to use a Query API, see Making API requests.
For information about other API actions you can perform on EC2 instances, see the Amazon EC2 API Reference.
For information about AWS AppConfig, a capability of Systems Manager, see the AWS AppConfig User Guide and the AWS AppConfig API Reference.
For information about AWS Incident Manager, a capability of Systems Manager, see the AWS Incident Manager User Guide and the AWS Incident Manager API Reference.
Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Setting up Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.
Related resources
For information about how to use a Query API, see Making API requests.
For information about other API operations you can perform on EC2 instances, see the Amazon EC2 API Reference.
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference.
For information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide and the Incident Manager API Reference.
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
", - "AssociateOpsItemRelatedItem": "Associates a related resource to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager is a capability of AWS Systems Manager.
", + "AddTagsToResource": "Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example:
Key=Owner,Value=DbAdmin
Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev
Key=Stack,Value=Production
Key=Stack,Value=Pre-Production
Key=Stack,Value=Test
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
", + "AssociateOpsItemRelatedItem": "Associates a related resource to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
", "CancelCommand": "Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
", - "CancelMaintenanceWindowExecution": "Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
", - "CreateActivation": "Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
", - "CreateAssociationBatch": "Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
", - "CreateDocument": "Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
", + "CancelMaintenanceWindowExecution": "Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.
", + "CreateActivation": "Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
On-premises servers or VMs that are registered with Systems Manager and Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage with Systems Manager are all called managed instances.
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
", + "CreateAssociationBatch": "Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
", + "CreateDocument": "Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.
", "CreateMaintenanceWindow": "Creates a new maintenance window.
The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
", - "CreateOpsMetadata": "If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.
", - "CreatePatchBaseline": "Creates a patch baseline.
For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.
You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization by using AWS Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
", - "DeleteAssociation": "Disassociates the specified Systems Manager document from the specified instance.
When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
", - "DeleteDocument": "Deletes the Systems Manager document and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
", + "CreateOpsItem": "Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
", + "CreateOpsMetadata": "If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
", + "CreatePatchBaseline": "Creates a patch baseline.
For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.
A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.
You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple accounts and Regions or EntireOrganization by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation doesn't de-register managed instances. You must manually de-register managed instances.
", + "DeleteAssociation": "Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified instance.
When you disassociate a document from an instance, it doesn't change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
", + "DeleteDocument": "Deletes the Amazon Web Services Systems Manager document (SSM document) and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
", "DeleteInventory": "Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
", "DeleteMaintenanceWindow": "Deletes a maintenance window.
", "DeleteOpsMetadata": "Delete OpsMetadata related to an application.
", "DeleteParameter": "Delete a parameter from the system.
", "DeleteParameters": "Delete a list of parameters.
", "DeletePatchBaseline": "Deletes a patch baseline.
", - "DeleteResourceDataSync": "Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
", + "DeleteResourceDataSync": "Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
", "DeregisterManagedInstance": "Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
", "DeregisterPatchBaselineForPatchGroup": "Removes a patch group from a patch baseline.
", "DeregisterTargetFromMaintenanceWindow": "Removes a target from a maintenance window.
", "DeregisterTaskFromMaintenanceWindow": "Removes a task from a maintenance window.
", - "DescribeActivations": "Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
", - "DescribeAssociation": "Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.
Use this API action to view information about a specific execution of a specific association.
", - "DescribeAssociationExecutions": "Use this API action to view all executions for a specific association ID.
", + "DescribeActivations": "Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the instances in the activation, and the number of instances registered by using this activation.
", + "DescribeAssociation": "Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and an Amazon Web Services Systems Manager document (SSM document), then you retrieve the association by specifying the document name and the instance ID.
Views information about a specific execution of a specific association.
", + "DescribeAssociationExecutions": "Views all executions for a specific association ID.
", "DescribeAutomationExecutions": "Provides details about all active and terminated Automation executions.
", "DescribeAutomationStepExecutions": "Information about all active and terminated step executions in an Automation workflow.
", "DescribeAvailablePatches": "Lists all patches eligible to be included in a patch baseline.
", - "DescribeDocument": "Describes the specified Systems Manager document.
", - "DescribeDocumentPermission": "Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
", + "DescribeDocument": "Describes the specified Amazon Web Services Systems Manager document (SSM document).
", + "DescribeDocumentPermission": "Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's account ID) or publicly (All).
", "DescribeEffectiveInstanceAssociations": "All associations for the instance(s).
", - "DescribeEffectivePatchesForPatchBaseline": "Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
", + "DescribeEffectivePatchesForPatchBaseline": "Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
", "DescribeInstanceAssociationsStatus": "The status of the associations for the instance(s).
", - "DescribeInstanceInformation": "Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you don't specify instance IDs, it returns information for all your instances. If you specify an instance ID that isn't valid or an instance that you don't own, you receive an error.
The IamRole field for this API operation is the Identity and Access Management (IAM) role assigned to on-premises instances. This call doesn't return the IAM role for EC2 instances.
Retrieves the high-level patch state of one or more instances.
", "DescribeInstancePatchStatesForPatchGroup": "Retrieves the high-level patch state for the instances in the specified patch group.
", "DescribeInstancePatches": "Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
", @@ -51,92 +51,92 @@ "DescribeMaintenanceWindowExecutions": "Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
", "DescribeMaintenanceWindowSchedule": "Retrieves information about upcoming executions of a maintenance window.
", "DescribeMaintenanceWindowTargets": "Lists the targets registered with the maintenance window.
", - "DescribeMaintenanceWindowTasks": "Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values do not affect the running of your task and can be ignored.
Retrieves the maintenance windows in an AWS account.
", + "DescribeMaintenanceWindowTasks": "Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.
Retrieves the maintenance windows in an account.
", "DescribeMaintenanceWindowsForTarget": "Retrieves information about the maintenance window targets or tasks that an instance is associated with.
", - "DescribeOpsItems": "Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
", - "DescribeParameters": "Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
Lists the patch baselines in your AWS account.
", - "DescribePatchGroupState": "Returns high-level aggregated patch compliance state for a patch group.
", + "DescribeOpsItems": "Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
", + "DescribeParameters": "Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
Lists the patch baselines in your account.
", + "DescribePatchGroupState": "Returns high-level aggregated patch compliance state information for a patch group.
", "DescribePatchGroups": "Lists all patch groups that have been registered with patch baselines.
", - "DescribePatchProperties": "Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | PRIORITY
Valid properties: PRODUCT | CLASSIFICATION
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | PRIORITY
Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
", - "DisassociateOpsItemRelatedItem": "Deletes the association between an OpsItem and a related resource. For example, this API action can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of AWS Systems Manager.
", + "DisassociateOpsItemRelatedItem": "Deletes the association between an OpsItem and a related resource. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
", "GetAutomationExecution": "Get detailed information about a particular Automation execution.
", - "GetCalendarState": "Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time, GetCalendarState returns the state of the calendar at a specific time, and returns the next time that the Change Calendar state will transition. If you do not specify a time, GetCalendarState assumes the current time. Change Calendar entries have two possible states: OPEN or CLOSED.
If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.
For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
", + "GetCalendarState": "Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.
If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.
For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
", "GetCommandInvocation": "Returns detailed information about command execution for an invocation or plugin.
GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific instance, use ListCommandInvocations. To get the command execution status across instances, use ListCommands.
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
", - "GetDefaultPatchBaseline": "Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
", - "GetDeployablePatchSnapshotForInstance": "Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
", - "GetDocument": "Gets the contents of the specified Systems Manager document.
", + "GetDefaultPatchBaseline": "Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you don't specify an operating system value, the default patch baseline for Windows is returned.
", + "GetDeployablePatchSnapshotForInstance": "Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).
If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local AWS credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target an instance with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
", "GetInventory": "Query inventory information.
", "GetInventorySchema": "Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
", "GetMaintenanceWindow": "Retrieves a maintenance window.
", "GetMaintenanceWindowExecution": "Retrieves details about a specific a maintenance window execution.
", "GetMaintenanceWindowExecutionTask": "Retrieves the details about a specific task run as part of a maintenance window execution.
", "GetMaintenanceWindowExecutionTaskInvocation": "Retrieves information about a specific task running on a specific target.
", - "GetMaintenanceWindowTask": "Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values do not affect the running of your task and can be ignored.
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
", + "GetMaintenanceWindowTask": "Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.
Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
", "GetOpsMetadata": "View operational metadata related to an application in Application Manager.
", - "GetOpsSummary": "View a summary of OpsItems based on specified filters and aggregators.
", - "GetParameter": "Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
", + "GetOpsSummary": "View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
", + "GetParameter": "Get information about a parameter by using the parameter name. Don't confuse this API operation with the GetParameters API operation.
", "GetParameterHistory": "Retrieves the history of all changes to a parameter.
", - "GetParameters": "Get details of a parameter. Don't confuse this API action with the GetParameter API action.
", - "GetParametersByPath": "Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
Get details of a parameter. Don't confuse this API operation with the GetParameter API operation.
", + "GetParametersByPath": "Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
Retrieves information about a patch baseline.
", "GetPatchBaselineForPatchGroup": "Retrieves the patch baseline that should be used for the specified patch group.
", - "GetServiceSetting": " ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
", - "LabelParameterVersion": "A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, \"aws,\" or \"ssm\" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.
Query the current service setting for the account.
", + "LabelParameterVersion": "A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, \"aws\" or \"ssm\" (not case sensitive). If a label fails to meet these requirements, then the label isn't associated with a parameter and the system displays it in the list of InvalidLabels.
Retrieves all versions of an association for a specific association ID.
", - "ListAssociations": "Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
", - "ListCommandInvocations": "An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
", - "ListCommands": "Lists the commands requested by users of the AWS account.
", - "ListComplianceItems": "For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
", + "ListAssociations": "Returns all State Manager associations in the current account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
", + "ListCommandInvocations": "An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
Lists the commands requested by users of the account.
", + "ListComplianceItems": "For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
", "ListComplianceSummaries": "Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
", "ListDocumentMetadataHistory": "Information about approval reviews for a version of an SSM document.
", "ListDocumentVersions": "List all versions for a document.
", - "ListDocuments": "Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
", + "ListDocuments": "Returns all Systems Manager (SSM) documents in the current account and Region. You can limit the results of this request by using a filter.
", "ListInventoryEntries": "A list of inventory items returned by the request.
", - "ListOpsItemEvents": "Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
", + "ListOpsItemEvents": "Returns a list of all OpsItem events in the current Region and account. You can limit the results to events associated with specific OpsItems by specifying a filter.
", "ListOpsItemRelatedItems": "Lists all related-item resources associated with an OpsItem.
", - "ListOpsMetadata": "Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
", + "ListOpsMetadata": "Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
", "ListResourceComplianceSummaries": "Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
", "ListResourceDataSync": "Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.
Returns a list of the tags assigned to the specified resource.
", - "ModifyDocumentPermission": "Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
", - "PutComplianceItems": "Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved for patches, or Failed for associations.
Severity: A patch severity. For example, critical.
DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical.
PatchState: A patch state. For example, InstancesWithFailedPatches.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
Returns a list of the tags assigned to the specified resource.
For information about the ID format for each supported resource type, see AddTagsToResource.
", + "ModifyDocumentPermission": "Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
", + "PutComplianceItems": "Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved for patches, or Failed for associations.
Severity: A patch severity. For example, critical.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical.
PatchState: A patch state. For example, InstancesWithFailedPatches.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
", "PutParameter": "Add a parameter to the system.
", - "RegisterDefaultPatchBaseline": "Defines the default patch baseline for the relevant operating system.
To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.
Defines the default patch baseline for the relevant operating system.
To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.
Registers a patch baseline for a patch group.
", "RegisterTargetWithMaintenanceWindow": "Registers a target with a maintenance window.
", "RegisterTaskWithMaintenanceWindow": "Adds a new task to a maintenance window.
", "RemoveTagsFromResource": "Removes tag keys from the specified resource.
", - "ResetServiceSetting": " ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
", - "ResumeSession": "Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.
Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.
", + "ResumeSession": "Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.
Sends a signal to an Automation execution to change the current behavior or status of the execution.
", "SendCommand": "Runs commands on one or more managed instances.
", - "StartAssociationsOnce": "Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
", - "StartAutomationExecution": "Initiates execution of an Automation document.
", - "StartChangeRequestExecution": "Creates a change request for Change Manager. The runbooks (Automation documents) specified in the change request run only after all required approvals for the change request have been received.
", - "StartSession": "Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the AWS CLI in the AWS Systems Manager User Guide.
AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
", + "StartAutomationExecution": "Initiates execution of an Automation runbook.
", + "StartChangeRequestExecution": "Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
", + "StartSession": "Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.
Stop an Automation that is currently running.
", - "TerminateSession": "Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
", + "TerminateSession": "Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session isn't be resumed.
", "UnlabelParameterVersion": "Remove a label or labels from a parameter.
", - "UpdateAssociation": "Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
In order to call this API action, your IAM user account, group, or role must be configured with permission to call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets.
Updates the status of the Systems Manager document associated with the specified instance.
", + "UpdateAssociation": "Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output.
In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets.
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified instance.
", "UpdateDocument": "Updates one or more values for an SSM document.
", "UpdateDocumentDefaultVersion": "Set the default version of a document.
", "UpdateDocumentMetadata": "Updates information related to approval reviews for a specific version of a document.
", "UpdateMaintenanceWindow": "Updates an existing maintenance window. Only specified parameters are modified.
The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
Modifies the target of an existing maintenance window. You can change the following:
Name
Description
Owner
IDs for an ID target
Tags for a Tag target
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field is not modified.
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field is not modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation.
", - "UpdateOpsItem": "Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
", - "UpdateOpsMetadata": "Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
", - "UpdatePatchBaseline": "Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
This API action only supports a resource data sync that was created with a SyncFromSource SyncType.
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.
Update the service setting for the account.
" + "UpdateMaintenanceWindowTarget": "Modifies the target of an existing maintenance window. You can change the following:
Name
Description
Owner
IDs for an ID target
Tags for a Tag target
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field isn't modified.
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field isn't modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't specified are set to null.
When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation.
", + "UpdateOpsItem": "Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
", + "UpdateOpsMetadata": "Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
", + "UpdatePatchBaseline": "Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
This API operation only supports a resource data sync that was created with a SyncFromSource SyncType.
ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.
Update the service setting for the account.
" }, "shapes": { "Account": { @@ -149,37 +149,37 @@ "base": null, "refs": { "AccountIdList$member": null, - "AccountSharingInfo$AccountId": "The AWS account ID where the current document is shared.
" + "AccountSharingInfo$AccountId": "The account ID where the current document is shared.
" } }, "AccountIdList": { "base": null, "refs": { - "DescribeDocumentPermissionResponse$AccountIds": "The account IDs that have permission to use this document. The ID can be either an AWS account or All.
", - "ModifyDocumentPermissionRequest$AccountIdsToAdd": "The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
", - "ModifyDocumentPermissionRequest$AccountIdsToRemove": "The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
" + "DescribeDocumentPermissionResponse$AccountIds": "The account IDs that have permission to use this document. The ID can be either an account or All.
", + "ModifyDocumentPermissionRequest$AccountIdsToAdd": "The Amazon Web Services user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
", + "ModifyDocumentPermissionRequest$AccountIdsToRemove": "The Amazon Web Services user accounts that should no longer have access to the document. The Amazon Web Services user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
" } }, "AccountSharingInfo": { - "base": "Information includes the AWS account ID where the current document is shared and the version shared with that account.
", + "base": "Information includes the account ID where the current document is shared and the version shared with that account.
", "refs": { "AccountSharingInfoList$member": null } }, "AccountSharingInfoList": { - "base": "A list of of AWS accounts where the current document is shared and the version shared with each account.
", + "base": "A list of of accounts where the current document is shared and the version shared with each account.
", "refs": { - "DescribeDocumentPermissionResponse$AccountSharingInfoList": "A list of AWS accounts where the current document is shared and the version shared with each account.
" + "DescribeDocumentPermissionResponse$AccountSharingInfoList": "A list of accounts where the current document is shared and the version shared with each account.
" } }, "Accounts": { "base": null, "refs": { - "TargetLocation$Accounts": "The AWS accounts targeted by the current Automation execution.
" + "TargetLocation$Accounts": "The accounts targeted by the current Automation execution.
" } }, "Activation": { - "base": "An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.
", + "base": "An activation registers one or more on-premises servers or virtual machines (VMs) with Amazon Web Services so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with Amazon Web Services Systems Manager is called a managed instance.
", "refs": { "ActivationList$member": null } @@ -194,7 +194,7 @@ "base": null, "refs": { "Activation$Description": "A user defined description of the activation.
", - "CreateActivationRequest$Description": "A user-defined description of the resource that you want to register with Systems Manager.
Do not enter personally identifiable information in this field.
A user-defined description of the resource that you want to register with Systems Manager.
Don't enter personally identifiable information in this field.
The ID created by Systems Manager when you submitted the activation.
", "CreateActivationResult$ActivationId": "The ID number generated by the system when it processed the activation. The activation ID functions like a user name.
", "DeleteActivationRequest$ActivationId": "The ID of the activation that you want to delete.
", - "InstanceInformation$ActivationId": "The activation ID created by Systems Manager when the server or VM was registered.
" + "InstanceInformation$ActivationId": "The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
" } }, "ActivationList": { "base": null, "refs": { - "DescribeActivationsResult$ActivationList": "A list of activations for your AWS account.
" + "DescribeActivationsResult$ActivationList": "A list of activations for your account.
" } }, "AddTagsToResourceRequest": { @@ -250,11 +250,11 @@ "ApplyOnlyAtCronInterval": { "base": null, "refs": { - "AssociationDescription$ApplyOnlyAtCronInterval": "By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
", - "AssociationVersionInfo$ApplyOnlyAtCronInterval": "By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
", - "CreateAssociationBatchRequestEntry$ApplyOnlyAtCronInterval": "By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
", - "CreateAssociationRequest$ApplyOnlyAtCronInterval": "By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
", - "UpdateAssociationRequest$ApplyOnlyAtCronInterval": "By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter is not supported for rate expressions.
Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
", + "AssociationVersionInfo$ApplyOnlyAtCronInterval": "By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
", + "CreateAssociationBatchRequestEntry$ApplyOnlyAtCronInterval": "By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
", + "CreateAssociationRequest$ApplyOnlyAtCronInterval": "By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
", + "UpdateAssociationRequest$ApplyOnlyAtCronInterval": "By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.
Describes an association of a Systems Manager document and an instance.
", + "base": "Describes an association of a Amazon Web Services Systems Manager document (SSM document) and an instance.
", "refs": { "AssociationList$member": null } @@ -316,7 +316,7 @@ } }, "AssociationDoesNotExist": { - "base": "The specified association does not exist.
", + "base": "The specified association doesn't exist.
", "refs": { } }, @@ -327,7 +327,7 @@ } }, "AssociationExecutionDoesNotExist": { - "base": "The specified execution ID does not exist. Verify the ID number and try again.
", + "base": "The specified execution ID doesn't exist. Verify the ID number and try again.
", "refs": { } }, @@ -420,7 +420,7 @@ "AssociationFilterList": { "base": null, "refs": { - "ListAssociationsRequest$AssociationFilterList": "One or more filters. Use a filter to return a more specific list of results.
Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the instance that are part of the Target Attributes ResourceGroup or Tags are not returned.
One or more filters. Use a filter to return a more specific list of results.
Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the instance that are part of the Target Attributes ResourceGroup or Tags aren't returned.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO mode.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO mode.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO mode.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO mode.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO mode.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO mode.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO mode.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO mode.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager. It is managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO mode.
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO mode.
A list of key and value pairs that describe attachments to a version of a document.
", - "UpdateDocumentRequest$Attachments": "A list of key and value pairs that describe attachments to a version of a document.
" + "CreateDocumentRequest$Attachments": "A list of key-value pairs that describe attachments to a version of a document.
", + "UpdateDocumentRequest$Attachments": "A list of key-value pairs that describe attachments to a version of a document.
" } }, "AttachmentsSourceValue": { @@ -680,12 +680,12 @@ } }, "AutomationDefinitionNotFoundException": { - "base": "An Automation document with the specified name could not be found.
", + "base": "An Automation runbook with the specified name couldn't be found.
", "refs": { } }, "AutomationDefinitionVersionNotFoundException": { - "base": "An Automation document with the specified name and version could not be found.
", + "base": "An Automation runbook with the specified name and version couldn't be found.
", "refs": { } }, @@ -731,9 +731,9 @@ "AutomationExecution$AutomationExecutionId": "The execution ID.
", "AutomationExecution$ParentAutomationExecutionId": "The AutomationExecutionId of the parent automation.
", "AutomationExecutionMetadata$AutomationExecutionId": "The execution ID.
", - "AutomationExecutionMetadata$ParentAutomationExecutionId": "The ExecutionId of the parent Automation.
", + "AutomationExecutionMetadata$ParentAutomationExecutionId": "The execution ID of the parent automation.
", "DescribeAutomationStepExecutionsRequest$AutomationExecutionId": "The Automation execution ID for which you want step execution descriptions.
", - "GetAutomationExecutionRequest$AutomationExecutionId": "The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated.
", + "GetAutomationExecutionRequest$AutomationExecutionId": "The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated.
", "SendAutomationSignalRequest$AutomationExecutionId": "The unique identifier for an existing Automation execution that you want to send the signal to.
", "StartAutomationExecutionResult$AutomationExecutionId": "The unique ID of a newly scheduled automation execution.
", "StartChangeRequestExecutionResult$AutomationExecutionId": "The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)
", @@ -774,7 +774,7 @@ "base": null, "refs": { "AutomationExecution$TargetParameterName": "The parameter name.
", - "AutomationExecutionMetadata$TargetParameterName": "The list of execution outputs as defined in the Automation document.
", + "AutomationExecutionMetadata$TargetParameterName": "The list of execution outputs as defined in the Automation runbook.
", "AutomationParameterMap$key": null, "Runbook$TargetParameterName": "The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
" @@ -783,14 +783,14 @@ "AutomationParameterMap": { "base": null, "refs": { - "AutomationExecution$Parameters": "The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
", - "AutomationExecution$Outputs": "The list of execution outputs as defined in the automation document.
", - "AutomationExecutionMetadata$Outputs": "The list of execution outputs as defined in the Automation document.
", + "AutomationExecution$Parameters": "The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
", + "AutomationExecution$Outputs": "The list of execution outputs as defined in the Automation runbook.
", + "AutomationExecutionMetadata$Outputs": "The list of execution outputs as defined in the Automation runbook.
", "FailureDetails$Details": "Detailed information about the Automation step failure.
", - "MaintenanceWindowAutomationParameters$Parameters": "The parameters for the AUTOMATION task.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
The parameters for the AUTOMATION task.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified for these parameters.
The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.
The data sent with the signal. The data schema depends on the type of signal used in the request.
For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:
Comment=\"Looks good\"
For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:
StepName=\"step1\"
For the StopStep signal type, you must send the step execution ID as the payload. For example:
StepExecutionId=\"97fff367-fc5a-4299-aed8-0123456789ab\"
A key-value map of execution parameters, which match the declared parameters in the Automation document.
", + "StartAutomationExecutionRequest$Parameters": "A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
", "StartChangeRequestExecutionRequest$Parameters": "A key-value map of parameters that match the declared parameters in the change template document.
", "StepExecution$Outputs": "Returned values from the execution of the step.
", "StepExecution$OverriddenParameters": "A user-specified list of parameters to override when running a step.
" @@ -823,16 +823,16 @@ "AutomationTargetParameterName": { "base": null, "refs": { - "AssociationDescription$AutomationTargetParameterName": "Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
", - "CreateAssociationBatchRequestEntry$AutomationTargetParameterName": "Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
", - "CreateAssociationRequest$AutomationTargetParameterName": "Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
", - "UpdateAssociationRequest$AutomationTargetParameterName": "Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
" + "AssociationDescription$AutomationTargetParameterName": "Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
", + "CreateAssociationBatchRequestEntry$AutomationTargetParameterName": "Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
", + "CreateAssociationRequest$AutomationTargetParameterName": "Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
", + "UpdateAssociationRequest$AutomationTargetParameterName": "Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
" } }, "AutomationType": { "base": null, "refs": { - "AutomationExecutionMetadata$AutomationType": "Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Running Automation workflows in multiple AWS Regions and accounts in the AWS Systems Manager User Guide.
" + "AutomationExecutionMetadata$AutomationType": "Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Regions and accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.
" } }, "BaselineDescription": { @@ -842,7 +842,7 @@ "GetPatchBaselineResult$Description": "A description of the patch baseline.
", "PatchBaselineIdentity$BaselineDescription": "The description of the patch baseline.
", "UpdatePatchBaselineRequest$Description": "A description of the patch baseline.
", - "UpdatePatchBaselineResult$Description": "A description of the Patch Baseline.
" + "UpdatePatchBaselineResult$Description": "A description of the patch baseline.
" } }, "BaselineId": { @@ -862,7 +862,7 @@ "PatchBaselineIdentity$BaselineId": "The ID of the patch baseline.
", "RegisterDefaultPatchBaselineRequest$BaselineId": "The ID of the patch baseline that should be the default patch baseline.
", "RegisterDefaultPatchBaselineResult$BaselineId": "The ID of the default patch baseline.
", - "RegisterPatchBaselineForPatchGroupRequest$BaselineId": "The ID of the patch baseline to register the patch group with.
", + "RegisterPatchBaselineForPatchGroupRequest$BaselineId": "The ID of the patch baseline to register with the patch group.
", "RegisterPatchBaselineForPatchGroupResult$BaselineId": "The ID of the patch baseline the patch group was registered with.
", "UpdatePatchBaselineRequest$BaselineId": "The ID of the patch baseline to update.
", "UpdatePatchBaselineResult$BaselineId": "The ID of the deleted patch baseline.
" @@ -894,32 +894,32 @@ "base": null, "refs": { "Activation$Expired": "Whether or not the activation is expired.
", - "AutomationExecution$StepExecutionsTruncated": "A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.
", - "BaselineOverride$ApprovedPatchesEnableNonSecurity": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
", - "CreatePatchBaselineRequest$ApprovedPatchesEnableNonSecurity": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
", - "DeleteDocumentRequest$Force": "Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.
The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target from the maintenance window.
", + "AutomationExecution$StepExecutionsTruncated": "A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.
", + "BaselineOverride$ApprovedPatchesEnableNonSecurity": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is false. Applies to Linux instances only.
Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is false. Applies to Linux instances only.
Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an Identity and Access Management (IAM) policy.
The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window.
", "DescribeAutomationStepExecutionsRequest$ReverseOrder": "Indicates whether to list step executions in reverse order by start time. The default value is 'false'.
", "DocumentVersionInfo$IsDefaultVersion": "An identifier for the default version of the document.
", - "GetParameterHistoryRequest$WithDecryption": "Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
", - "GetParameterRequest$WithDecryption": "Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
", - "GetParametersByPathRequest$Recursive": "Retrieve all parameters within a hierarchy.
If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.
Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
Retrieve all parameters within a hierarchy.
If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.
Retrieve all parameters in a hierarchy with their value decrypted.
", - "GetParametersRequest$WithDecryption": "Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
", - "GetPatchBaselineResult$ApprovedPatchesEnableNonSecurity": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
", - "InstanceInformation$IsLatestVersion": "Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field does not indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process SSM requests.
", - "ListCommandInvocationsRequest$Details": "(Optional) If set this returns the response of the command executions and any command output. The default value is 'false'.
", - "PatchRule$EnableNonSecurity": "For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only.
", - "PutParameterRequest$Overwrite": "Overwrite an existing parameter. The default value is 'false'.
", + "GetParametersRequest$WithDecryption": "Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is false. Applies to Linux instances only.
Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field doesn't indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.
", + "ListCommandInvocationsRequest$Details": "(Optional) If set this returns the response of the command executions and any command output. The default value is false.
For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is false. Applies to Linux instances only.
Overwrite an existing parameter. The default value is false.
A boolean value indicating whether the resolved target list is truncated.
", "StepExecution$IsEnd": "The flag which can be used to end automation no matter whether the step succeeds or fails.
", "StepExecution$IsCritical": "The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
", - "UpdateMaintenanceWindowRequest$Replace": "If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
", - "UpdateMaintenanceWindowTargetRequest$Replace": "If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
", - "UpdateMaintenanceWindowTaskRequest$Replace": "If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
", - "UpdatePatchBaselineRequest$ApprovedPatchesEnableNonSecurity": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
", - "UpdatePatchBaselineRequest$Replace": "If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null.
", - "UpdatePatchBaselineResult$ApprovedPatchesEnableNonSecurity": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
" + "UpdateMaintenanceWindowRequest$Replace": "If True, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.
If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.
If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.
", + "UpdatePatchBaselineRequest$ApprovedPatchesEnableNonSecurity": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is false. Applies to Linux instances only.
If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.
", + "UpdatePatchBaselineResult$ApprovedPatchesEnableNonSecurity": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is false. Applies to Linux instances only.
The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.
", - "AssociationVersionInfo$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.
", - "CreateAssociationBatchRequestEntry$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.
", - "CreateAssociationRequest$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents you want to gate your associations under. The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.
", - "GetCalendarStateRequest$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Systems Manager documents that represent the calendar entries for which you want to get the state.
", - "UpdateAssociationRequest$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents you want to gate your associations under. The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.
" + "AssociationDescription$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
", + "AssociationVersionInfo$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
", + "CreateAssociationBatchRequestEntry$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
", + "CreateAssociationRequest$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
", + "GetCalendarStateRequest$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.
", + "UpdateAssociationRequest$CalendarNames": "The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
" } }, "CalendarState": { "base": null, "refs": { - "GetCalendarStateResponse$State": "The state of the calendar. An OPEN calendar indicates that actions are allowed to proceed, and a CLOSED calendar indicates that actions are not allowed to proceed.
The state of the calendar. An OPEN calendar indicates that actions are allowed to proceed, and a CLOSED calendar indicates that actions aren't allowed to proceed.
The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
" + "CloudWatchOutputConfig$CloudWatchLogGroupName": "The name of the CloudWatch Logs log group where you want to send command output. If you don't specify a group name, Amazon Web Services Systems Manager automatically creates a log group for you. The log group uses the following naming format:
aws/ssm/SystemsManagerDocumentName
Configuration options for sending command output to CloudWatch Logs.
", + "base": "Configuration options for sending command output to Amazon CloudWatch Logs.
", "refs": { - "Command$CloudWatchOutputConfig": "CloudWatch Logs information where you want Systems Manager to send the command output.
", - "CommandInvocation$CloudWatchOutputConfig": "CloudWatch Logs information where you want Systems Manager to send the command output.
", - "GetCommandInvocationResult$CloudWatchOutputConfig": "CloudWatch Logs information where Systems Manager sent the command output.
", + "Command$CloudWatchOutputConfig": "Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
", + "CommandInvocation$CloudWatchOutputConfig": "Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
", + "GetCommandInvocationResult$CloudWatchOutputConfig": "Amazon CloudWatch Logs information where Systems Manager sent the command output.
", "MaintenanceWindowRunCommandParameters$CloudWatchOutputConfig": null, - "SendCommandRequest$CloudWatchOutputConfig": "Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
" + "SendCommandRequest$CloudWatchOutputConfig": "Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
" } }, "CloudWatchOutputEnabled": { @@ -1039,7 +1039,7 @@ "CommandFilterValue": { "base": null, "refs": { - "CommandFilter$value": "The filter value. Valid values for each filter key are as follows:
InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions occurring July 7, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions from before July 7, 2018.
Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:
Pending
InProgress
Success
Cancelled
Failed
TimedOut
Cancelling
DocumentName: Specify name of the SSM document for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances.
ExecutionStage: Specify one of the following values:
Executing: Returns a list of command executions that are currently still running.
Complete: Returns a list of command executions that have already completed.
The filter value. Valid values for each filter key are as follows:
InvokedAfter: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions occurring July 7, 2021, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions from before July 7, 2021.
Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:
Pending
InProgress
Success
Cancelled
Failed
TimedOut
Cancelling
DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances.
ExecutionStage: Specify one of the following values:
Executing: Returns a list of command executions that are currently still running.
Complete: Returns a list of command executions that have already completed.
The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
", - "GetCommandInvocationRequest$PluginName": "The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.
Plugin names are also referred to as step names in Systems Manager documents. For example, aws:RunShellScript is a plugin.
To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.
The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.
Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.
To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.
The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.
The total number of resources that are compliant.
", - "NonCompliantSummary$NonCompliantCount": "The total number of compliance items that are not compliant.
", + "NonCompliantSummary$NonCompliantCount": "The total number of compliance items that aren't compliant.
", "SeveritySummary$CriticalCount": "The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items.
", "SeveritySummary$HighCount": "The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.
", "SeveritySummary$MediumCount": "The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.
", @@ -1387,7 +1387,7 @@ } }, "CreateAssociationBatchRequestEntry": { - "base": "Describes the association of a Systems Manager SSM document and an instance.
", + "base": "Describes the association of a Amazon Web Services Systems Manager document (SSM document) and an instance.
", "refs": { "CreateAssociationBatchRequestEntries$member": null, "FailedCreateAssociation$Entry": "The association.
" @@ -1496,9 +1496,9 @@ "AutomationExecution$ExecutionEndTime": "The time the execution finished.
", "AutomationExecution$ScheduledTime": "The date and time the Automation operation is scheduled to start.
", "AutomationExecutionMetadata$ExecutionStartTime": "The time the execution started.
", - "AutomationExecutionMetadata$ExecutionEndTime": "The time the execution finished. This is not populated if the execution is still in progress.
", + "AutomationExecutionMetadata$ExecutionEndTime": "The time the execution finished. This isn't populated if the execution is still in progress.
", "AutomationExecutionMetadata$ScheduledTime": "The date and time the Automation operation is scheduled to start.
", - "Command$ExpiresAfter": "If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
", + "Command$ExpiresAfter": "If this time is reached and the command hasn't already started running, it won't run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API operation.
The date and time the command was requested.
", "CommandInvocation$RequestedDateTime": "The time and date the request was sent to this instance.
", "CommandPlugin$ResponseStartDateTime": "The time the plugin started running.
", @@ -1509,11 +1509,11 @@ "CreateOpsItemRequest$PlannedStartTime": "The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
The date when the document was created.
", - "DocumentIdentifier$CreatedDate": "The date the Systems Manager document was created.
", + "DocumentIdentifier$CreatedDate": "The date the SSM document was created.
", "DocumentReviewerResponseSource$CreateTime": "The date and time that a reviewer entered a response to a document review request.
", "DocumentReviewerResponseSource$UpdatedTime": "The date and time that a reviewer last updated a response to a document review request.
", "DocumentVersionInfo$CreatedDate": "The date the document was created.
", - "GetDocumentResult$CreatedDate": "The date the Systems Manager document was created.
", + "GetDocumentResult$CreatedDate": "The date the SSM document was created.
", "GetMaintenanceWindowExecutionResult$StartTime": "The time the maintenance window started running.
", "GetMaintenanceWindowExecutionResult$EndTime": "The time the maintenance window finished running.
", "GetMaintenanceWindowExecutionTaskInvocationResult$StartTime": "The time that the task started running on the target.
", @@ -1526,7 +1526,7 @@ "GetPatchBaselineResult$ModifiedDate": "The date the patch baseline was last modified.
", "InstanceAssociationStatusInfo$ExecutionDate": "The date the instance association ran.
", "InstanceInformation$LastPingDateTime": "The date and time when the agent last pinged the Systems Manager service.
", - "InstanceInformation$RegistrationDate": "The date the server or VM was registered with AWS as a managed instance.
", + "InstanceInformation$RegistrationDate": "The date the server or VM was registered with Amazon Web Services as a managed instance.
", "InstanceInformation$LastAssociationExecutionDate": "The date the association was last run.
", "InstanceInformation$LastSuccessfulAssociationExecutionDate": "The last date the association was successfully run.
", "InstancePatchState$OperationStartTime": "The time the most recent patching operation was started on the instance.
", @@ -1559,16 +1559,16 @@ "ParameterHistory$LastModifiedDate": "Date the parameter was last changed or updated.
", "ParameterMetadata$LastModifiedDate": "Date the parameter was last changed or updated.
", "Patch$ReleaseDate": "The date the patch was released.
", - "PatchComplianceData$InstalledTime": "The date/time the patch was installed on the instance. Note that not all operating systems provide this level of information.
", - "PatchStatus$ApprovalDate": "The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).
", + "PatchComplianceData$InstalledTime": "The date/time the patch was installed on the instance. Not all operating systems provide this level of information.
", + "PatchStatus$ApprovalDate": "The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).
The time that the reviewer took action on the document review request.
", "ServiceSetting$LastModifiedDate": "The last time the service setting was modified.
", "Session$StartDate": "The date and time, in ISO-8601 Extended format, when the session began.
", "Session$EndDate": "The date and time, in ISO-8601 Extended format, when the session was terminated.
", "StartChangeRequestExecutionRequest$ScheduledTime": "The date and time specified in the change request to run the Automation runbooks.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.
", - "StepExecution$ExecutionStartTime": "If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.
", - "StepExecution$ExecutionEndTime": "If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
", + "StepExecution$ExecutionStartTime": "If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.
", + "StepExecution$ExecutionEndTime": "If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.
", "UpdateOpsItemRequest$ActualStartTime": "The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
" + "PatchBaselineIdentity$DefaultBaseline": "Whether this is the default baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
" } }, "DefaultInstanceName": { "base": null, "refs": { "Activation$DefaultInstanceName": "A name for the managed instance when it is created.
", - "CreateActivationRequest$DefaultInstanceName": "The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.
Do not enter personally identifiable information in this field.
The name of the registered, managed instance as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.
Don't enter personally identifiable information in this field.
The name of the Systems Manager document.
", - "AssociationDescription$Name": "The name of the Systems Manager document.
", + "Association$Name": "The name of the SSM document.
", + "AssociationDescription$Name": "The name of the SSM document.
", "AssociationVersionInfo$Name": "The name specified when the association was created.
", - "CreateAssociationBatchRequestEntry$Name": "The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:partition:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
The name of the Systems Manager document.
", - "DescribeAssociationRequest$Name": "The name of the Systems Manager document.
", - "DescribeDocumentRequest$Name": "The name of the Systems Manager document.
", - "DocumentDescription$Name": "The name of the Systems Manager document.
", - "DocumentIdentifier$Name": "The name of the Systems Manager document.
", + "CreateAssociationBatchRequestEntry$Name": "The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager documents (SSM documents) that are shared with you from other accounts, you must specify the complete SSM document ARN, in the following format:
arn:partition:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
The name of the SSM document.
", + "DescribeAssociationRequest$Name": "The name of the SSM document.
", + "DescribeDocumentRequest$Name": "The name of the SSM document.
", + "DocumentDescription$Name": "The name of the SSM document.
", + "DocumentIdentifier$Name": "The name of the SSM document.
", "DocumentRequires$Name": "The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
", - "GetDocumentRequest$Name": "The name of the Systems Manager document.
", - "GetDocumentResult$Name": "The name of the Systems Manager document.
", + "GetDocumentRequest$Name": "The name of the SSM document.
", + "GetDocumentResult$Name": "The name of the SSM document.
", "InstanceAssociationStatusInfo$Name": "The name of the association.
", "ListDocumentVersionsRequest$Name": "The name of the document. You can specify an Amazon Resource Name (ARN).
", - "Runbook$DocumentName": "The name of the Automation runbook (Automation document) used in a runbook workflow.
", - "SendCommandRequest$DocumentName": "The name of the Systems Manager document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the AWS Systems Manager User Guide.
", - "StartAutomationExecutionRequest$DocumentName": "The name of the Systems Manager document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the AWS Systems Manager User Guide.
", + "Runbook$DocumentName": "The name of the Automation runbook used in a runbook workflow.
", + "SendCommandRequest$DocumentName": "The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.
", + "StartAutomationExecutionRequest$DocumentName": "The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.
", "StartChangeRequestExecutionRequest$DocumentName": "The name of the change template document to run during the runbook workflow.
", "StartSessionRequest$DocumentName": "The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the instance is launched by default.
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
The name of the Systems Manager document.
" + "UpdateAssociationRequest$Name": "The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
The name of the SSM document.
" } }, "DocumentAlreadyExists": { @@ -2133,8 +2133,8 @@ "DocumentContent": { "base": null, "refs": { - "CreateDocumentRequest$Content": "The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.
For examples, see the following topics in the AWS Systems Manager User Guide.
", - "GetDocumentResult$Content": "The contents of the Systems Manager document.
", + "CreateDocumentRequest$Content": "The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.
For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.
The contents of the SSM document.
", "InstanceAssociation$Content": "The content of the association document for the instance(s).
", "UpdateDocumentRequest$Content": "A valid JSON or YAML string.
" } @@ -2146,22 +2146,22 @@ } }, "DocumentDescription": { - "base": "Describes a Systems Manager document.
", + "base": "Describes a Amazon Web Services Systems Manager document (SSM document).
", "refs": { - "CreateDocumentResult$DocumentDescription": "Information about the Systems Manager document.
", - "DescribeDocumentResult$Document": "Information about the Systems Manager document.
", + "CreateDocumentResult$DocumentDescription": "Information about the SSM document.
", + "DescribeDocumentResult$Document": "Information about the SSM document.
", "UpdateDocumentResult$DocumentDescription": "A description of the document that was updated.
" } }, "DocumentDisplayName": { "base": null, "refs": { - "CreateDocumentRequest$DisplayName": "An optional field where you can specify a friendly name for the Systems Manager document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument action.
", - "DocumentDescription$DisplayName": "The friendly name of the Systems Manager document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
", - "DocumentIdentifier$DisplayName": "An optional field where you can specify a friendly name for the Systems Manager document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
", - "DocumentVersionInfo$DisplayName": "The friendly name of the Systems Manager document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
", - "GetDocumentResult$DisplayName": "The friendly name of the Systems Manager document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
", - "UpdateDocumentRequest$DisplayName": "The friendly name of the Systems Manager document that you want to update. This value can differ for each version of the document. If you do not specify a value for this parameter in your request, the existing value is applied to the new document version.
" + "CreateDocumentRequest$DisplayName": "An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.
", + "DocumentDescription$DisplayName": "The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
", + "DocumentIdentifier$DisplayName": "An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
", + "DocumentVersionInfo$DisplayName": "The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
", + "GetDocumentResult$DisplayName": "The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
", + "UpdateDocumentRequest$DisplayName": "The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.
" } }, "DocumentFilter": { @@ -2217,7 +2217,7 @@ } }, "DocumentIdentifier": { - "base": "Describes the name of a Systems Manager document.
", + "base": "Describes the name of a SSM document.
", "refs": { "DocumentIdentifierList$member": null } @@ -2225,11 +2225,11 @@ "DocumentIdentifierList": { "base": null, "refs": { - "ListDocumentsResult$DocumentIdentifiers": "The names of the Systems Manager documents.
" + "ListDocumentsResult$DocumentIdentifiers": "The names of the SSM documents.
" } }, "DocumentKeyValuesFilter": { - "base": "One or more filters. Use a filter to return a more specific list of documents.
For keys, you can specify one or more tags that have been applied to a document.
You can also use AWS-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:
ApplicationConfiguration
ApplicationConfigurationSchema
Automation
ChangeCalendar
Command
DeploymentStrategy
Package
Policy
Session
Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.
Amazon
Private
Public
Self
ThirdParty
Linux
Windows
Name is another AWS-provided key. If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the AWS CLI, to return a list of all documents that begin with Te, run the following command:
aws ssm list-documents --filters Key=Name,Values=Te
You can also use the TargetType AWS-provided key. For a list of valid resource type values that can be used with this key, see AWS resource and property types reference in the AWS CloudFormation User Guide.
If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.
To specify a custom key and value pair, use the format Key=tag:tagName,Values=valueName.
For example, if you created a key called region and are using the AWS CLI to call the list-documents command:
aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self
One or more filters. Use a filter to return a more specific list of documents.
For keys, you can specify one or more tags that have been applied to a document.
You can also use Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:
ApplicationConfiguration
ApplicationConfigurationSchema
Automation
ChangeCalendar
Command
DeploymentStrategy
Package
Policy
Session
Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.
Amazon
Private
Public
Self
ThirdParty
Linux
Windows
Name is another Amazon Web Services-provided key. If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the Amazon Web Services CLI, to return a list of all documents that begin with Te, run the following command:
aws ssm list-documents --filters Key=Name,Values=Te
You can also use the TargetType Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.
To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
For example, if you created a key called region and are using the Amazon Web Services CLI to call the list-documents command:
aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self
One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
This API action only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2
One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2
You can have at most 500 active Systems Manager documents.
", + "base": "You can have at most 500 active SSM documents.
", "refs": { } }, @@ -2278,11 +2278,11 @@ "DocumentName": { "base": null, "refs": { - "AutomationExecution$DocumentName": "The name of the Automation document used during the execution.
", - "AutomationExecutionMetadata$DocumentName": "The name of the Automation document used during execution.
", + "AutomationExecution$DocumentName": "The name of the Automation runbook used during the execution.
", + "AutomationExecutionMetadata$DocumentName": "The name of the Automation runbook used during execution.
", "Command$DocumentName": "The name of the document requested for execution.
", "CommandInvocation$DocumentName": "The document name that was requested for execution.
", - "CreateDocumentRequest$Name": "A name for the Systems Manager document.
You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:
aws-
amazon
amzn
A name for the SSM document.
You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:
aws-
amazon
amzn
The name of the document.
", "DescribeDocumentPermissionRequest$Name": "The name of the document for which you are the owner.
", "DocumentDefaultVersionDescription$Name": "The name of the document.
", @@ -2294,14 +2294,14 @@ "Session$DocumentName": "The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.
The name of a custom document that you want to set as the default version.
", "UpdateDocumentMetadataRequest$Name": "The name of the document for which a version is to be updated.
", - "UpdateDocumentRequest$Name": "The name of the Systems Manager document that you want to update.
" + "UpdateDocumentRequest$Name": "The name of the SSM document that you want to update.
" } }, "DocumentOwner": { "base": null, "refs": { - "DocumentDescription$Owner": "The AWS user account that created the document.
", - "DocumentIdentifier$Owner": "The AWS user account that created the document.
" + "DocumentDescription$Owner": "The Amazon Web Services user account that created the document.
", + "DocumentIdentifier$Owner": "The Amazon Web Services user account that created the document.
" } }, "DocumentParameter": { @@ -2341,7 +2341,7 @@ } }, "DocumentPermissionLimit": { - "base": "The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS Support.
", + "base": "The document can't be shared with more Amazon Web Services user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact Amazon Web Services Support.
", "refs": { } }, @@ -2367,7 +2367,7 @@ "DocumentRequiresList": { "base": null, "refs": { - "CreateDocumentRequest$Requires": "A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see AWS AppConfig in the AWS Systems Manager User Guide.
A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
The status of a document.
", "refs": { - "DocumentDescription$Status": "The status of the Systems Manager document.
", - "DocumentVersionInfo$Status": "The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
The status of the SSM document.
", + "DocumentVersionInfo$Status": "The status of the SSM document, such as Creating, Active, Failed, and Deleting.
The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.
A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.\"
A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.\"
A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.\"
A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\"
A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\"
A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\"
The version of the document used in the association.
", "AssociationDescription$DocumentVersion": "The document version.
", - "AssociationVersionInfo$DocumentVersion": "The version of a Systems Manager document used when the association version was created.
", + "AssociationVersionInfo$DocumentVersion": "The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.
", "AutomationExecution$DocumentVersion": "The version of the document to use during execution.
", "AutomationExecutionMetadata$DocumentVersion": "The document version used during the execution.
", - "Command$DocumentVersion": "The SSM document version.
", - "CommandInvocation$DocumentVersion": "The SSM document version.
", + "Command$DocumentVersion": "The Systems Manager document (SSM document) version.
", + "CommandInvocation$DocumentVersion": "The Systems Manager document (SSM document) version.
", "CreateAssociationBatchRequestEntry$DocumentVersion": "The document version.
", "CreateAssociationRequest$DocumentVersion": "The document version you want to associate with the target(s). Can be a specific version or the default version.
", "DeleteDocumentRequest$DocumentVersion": "The version of the document that you want to delete. If not provided, all versions of the document are deleted.
", @@ -2483,17 +2483,17 @@ "DocumentIdentifier$DocumentVersion": "The document version.
", "DocumentRequires$Version": "The document version required by the current document.
", "DocumentVersionInfo$DocumentVersion": "The document version.
", - "GetCommandInvocationResult$DocumentVersion": "The SSM document version used in the request.
", + "GetCommandInvocationResult$DocumentVersion": "The Systems Manager document (SSM document) version used in the request.
", "GetDocumentRequest$DocumentVersion": "The document version for which you want information.
", "GetDocumentResult$DocumentVersion": "The document version.
", "InstanceAssociationStatusInfo$DocumentVersion": "The association document versions.
", "ListDocumentMetadataHistoryRequest$DocumentVersion": "The version of the document.
", "ListDocumentMetadataHistoryResponse$DocumentVersion": "The version of the document.
", - "MaintenanceWindowAutomationParameters$DocumentVersion": "The version of an Automation document to use during task execution.
", - "MaintenanceWindowRunCommandParameters$DocumentVersion": "The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
--document-version \"\\$DEFAULT\"
--document-version \"\\$LATEST\"
--document-version \"3\"
", - "Runbook$DocumentVersion": "The version of the Automation runbook (Automation document) used in a runbook workflow.
", - "SendCommandRequest$DocumentVersion": "The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
--document-version \"\\$DEFAULT\"
--document-version \"\\$LATEST\"
--document-version \"3\"
", - "StartAutomationExecutionRequest$DocumentVersion": "The version of the Automation document to use for this execution.
", + "MaintenanceWindowAutomationParameters$DocumentVersion": "The version of an Automation runbook to use during task execution.
", + "MaintenanceWindowRunCommandParameters$DocumentVersion": "The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
--document-version \"\\$DEFAULT\"
--document-version \"\\$LATEST\"
--document-version \"3\"
The version of the Automation runbook used in a runbook workflow.
", + "SendCommandRequest$DocumentVersion": "The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
--document-version \"\\$DEFAULT\"
--document-version \"\\$LATEST\"
--document-version \"3\"
", + "StartAutomationExecutionRequest$DocumentVersion": "The version of the Automation runbook to use for this execution.
", "StartChangeRequestExecutionRequest$DocumentVersion": "The version of the change template document to run during the runbook workflow.
", "UpdateAssociationRequest$DocumentVersion": "The document version you want update for the association.
", "UpdateDocumentMetadataRequest$DocumentVersion": "The version of a document to update.
", @@ -2520,16 +2520,16 @@ "DocumentVersionName": { "base": null, "refs": { - "CreateDocumentRequest$VersionName": "An optional field specifying the version of the artifact you are creating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.
", + "CreateDocumentRequest$VersionName": "An optional field specifying the version of the artifact you are creating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
", "DeleteDocumentRequest$VersionName": "The version name of the document that you want to delete. If not provided, all versions of the document are deleted.
", - "DescribeDocumentRequest$VersionName": "An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.
", + "DescribeDocumentRequest$VersionName": "An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
", "DocumentDefaultVersionDescription$DefaultVersionName": "The default version of the artifact associated with the document.
", "DocumentDescription$VersionName": "The version of the artifact associated with the document.
", - "DocumentIdentifier$VersionName": "An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.
", - "DocumentVersionInfo$VersionName": "The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.
", + "DocumentIdentifier$VersionName": "An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
", + "DocumentVersionInfo$VersionName": "The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
", "GetDocumentRequest$VersionName": "An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document and can't be changed.
", - "GetDocumentResult$VersionName": "The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.
", - "UpdateDocumentRequest$VersionName": "An optional field specifying the version of the artifact you are updating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.
" + "GetDocumentResult$VersionName": "The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
", + "UpdateDocumentRequest$VersionName": "An optional field specifying the version of the artifact you are updating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
" } }, "DocumentVersionNumber": { @@ -2539,7 +2539,7 @@ } }, "DoesNotExistException": { - "base": "Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
", + "base": "Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.
For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
", "refs": { } }, @@ -2560,7 +2560,7 @@ } }, "DuplicateInstanceId": { - "base": "You cannot specify an instance ID in more than one association.
", + "base": "You can't specify an instance ID in more than one association.
", "refs": { } }, @@ -2571,7 +2571,7 @@ } }, "EffectivePatch": { - "base": "The EffectivePatch structure defines metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.
", + "base": "The EffectivePatch structure defines metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.
You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service is not available.
", + "base": "You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service isn't available.
The request body of the GetServiceSetting API action.
", + "base": "The request body of the GetServiceSetting API operation.
", "refs": { } }, "GetServiceSettingResult": { - "base": "The query result body of the GetServiceSetting API action.
", + "base": "The query result body of the GetServiceSetting API operation.
", "refs": { } }, "HierarchyLevelLimitExceededException": { - "base": "A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the AWS Systems Manager User Guide.
", + "base": "A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the Amazon Web Services Systems Manager User Guide.
", "refs": { } }, "HierarchyTypeMismatchException": { - "base": "Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.
Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.
(Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you do not add AtTime, the current time is assumed.
The time, as an ISO 8601 string, that you specified in your command. If you did not specify a time, GetCalendarState uses the current time.
(Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you don't specify a value or AtTime, the current time is used.
The time, as an ISO 8601 string, that you specified in your command. If you don't specify a time, GetCalendarState uses the current time.
The time, as an ISO 8601 string, that the calendar state will change. If the current calendar state is OPEN, NextTransitionTime indicates when the calendar state changes to CLOSED, and vice-versa.
The Amazon Identity and Access Management (IAM) role to assign to the managed instance.
", - "CreateActivationRequest$IamRole": "The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.
The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance. This call does not return the IAM role for EC2 instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances action. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.
The Identity and Access Management (IAM) role to assign to the managed instance.
", + "CreateActivationRequest$IamRole": "The Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAMrole must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.
The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.
The IAM role you want to assign or change.
" } }, @@ -2949,7 +2949,7 @@ "InstallOverrideList": { "base": null, "refs": { - "InstancePatchState$InstallOverrideList": "An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.
For more information about the InstallOverrideList parameter, see About the SSM document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.
An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.
For more information about the InstallOverrideList parameter, see About the AWS-RunPatchBaseline SSM document in the Amazon Web Services Systems Manager User Guide.
An S3 bucket where you want to store the output details of the request.
", "AssociationVersionInfo$OutputLocation": "The location in Amazon S3 specified for the association when the association version was created.
", "CreateAssociationBatchRequestEntry$OutputLocation": "An S3 bucket where you want to store the results of this request.
", - "CreateAssociationRequest$OutputLocation": "An S3 bucket where you want to store the output details of the request.
", + "CreateAssociationRequest$OutputLocation": "An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
", "UpdateAssociationRequest$OutputLocation": "An S3 bucket where you want to store the results of this request.
" } }, @@ -3024,13 +3024,13 @@ "AssociationDescription$InstanceId": "The ID of the instance.
", "CommandInvocation$InstanceId": "The instance ID in which this invocation was requested.
", "CreateAssociationBatchRequestEntry$InstanceId": "The ID of the instance.
", - "CreateAssociationRequest$InstanceId": "The instance ID.
InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
The instance ID.
InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
The ID of the instance.
", "DescribeAssociationRequest$InstanceId": "The instance ID.
", "DescribeEffectiveInstanceAssociationsRequest$InstanceId": "The instance ID for which you want to view all associations.
", "DescribeInstanceAssociationsStatusRequest$InstanceId": "The instance IDs for which you want association status information.
", "DescribeInstancePatchesRequest$InstanceId": "The ID of the instance whose patch state information should be retrieved.
", - "GetCommandInvocationRequest$InstanceId": "(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for AWS Systems Manager.
", + "GetCommandInvocationRequest$InstanceId": "(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.
", "GetCommandInvocationResult$InstanceId": "The ID of the managed instance targeted by the command. A managed instance can be an EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
", "GetDeployablePatchSnapshotForInstanceRequest$InstanceId": "The ID of the instance for which the appropriate patch snapshot should be retrieved.
", "GetDeployablePatchSnapshotForInstanceResult$InstanceId": "The ID of the instance.
", @@ -3040,7 +3040,7 @@ "InstanceInformation$InstanceId": "The instance ID.
", "InstancePatchState$InstanceId": "The ID of the managed instance the high-level patch compliance information was collected for.
", "ListCommandInvocationsRequest$InstanceId": "(Optional) The command execution details for a specific instance ID.
", - "ListCommandsRequest$InstanceId": "(Optional) Lists commands issued against this instance ID.
You can't specify an instance ID in the same command that you specify Status = Pending. This is because the command has not reached the instance yet.
(Optional) Lists commands issued against this instance ID.
You can't specify an instance ID in the same command that you specify Status = Pending. This is because the command hasn't reached the instance yet.
The instance ID for which you want inventory information.
", "ListInventoryEntriesResult$InstanceId": "The instance ID targeted by the request to query inventory information.
", "PutInventoryRequest$InstanceId": "An instance ID where you want to add or update inventory items.
", @@ -3052,8 +3052,8 @@ "refs": { "CancelCommandRequest$InstanceIds": "(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.
", "Command$InstanceIds": "The instance IDs against which this command was requested.
", - "DescribeInstancePatchStatesRequest$InstanceIds": "The ID of the instance whose patch state information should be retrieved.
", - "SendCommandRequest$InstanceIds": "The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.
To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.
For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the AWS Systems Manager User Guide.
" + "DescribeInstancePatchStatesRequest$InstanceIds": "The ID of the instance for which patch state information should be retrieved.
", + "SendCommandRequest$InstanceIds": "The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.
To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.
For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.
" } }, "InstanceInformation": { @@ -3063,7 +3063,7 @@ } }, "InstanceInformationFilter": { - "base": "Describes a filter for a specific list of instances. You can filter instances information by using tags. You specify tags by using a key-value mapping.
Use this action instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The InstanceInformationFilterList method is a legacy method and does not support tags.
Describes a filter for a specific list of instances. You can filter instances information by using tags. You specify tags by using a key-value mapping.
Use this operation instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The InstanceInformationFilterList method is a legacy method and doesn't support tags.
The filter key name to describe your instances. For example:
\"InstanceIds\"|\"AgentVersion\"|\"PingStatus\"|\"PlatformTypes\"|\"ActivationIds\"|\"IamRole\"|\"ResourceType\"|\"AssociationStatus\"|\"Tag Key\"
Tag key is not a valid filter. You must specify either tag-key or tag:keyname and a string. Here are some valid examples: tag-key, tag:123, tag:al!, tag:Windows. Here are some invalid examples: tag-keys, Tag Key, tag:, tagKey, abc:keyname.
The filter key name to describe your instances. For example:
\"InstanceIds\"|\"AgentVersion\"|\"PingStatus\"|\"PlatformTypes\"|\"ActivationIds\"|\"IamRole\"|\"ResourceType\"|\"AssociationStatus\"|\"Tag Key\"
Tag key isn't a valid filter. You must specify either tag-key or tag:keyname and a string. Here are some valid examples: tag-key, tag:123, tag:al!, tag:Windows. Here are some invalid examples: tag-keys, Tag Key, tag:, tagKey, abc:keyname.
Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to scope down the information returned by the API.
", + "base": "Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope down the information returned by the API.
Example: To filter for all instances in a patch group having more than three patches with a FailedCount status, use the following for the filter:
Value for Key: FailedCount
Value for Type: GreaterThan
Value for Values: 3
The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.
" + "InstancePatchStateFilter$Key": "The key for the filter. Supported values include the following:
InstalledCount
InstalledOtherCount
InstalledPendingRebootCount
InstalledRejectedCount
MissingCount
FailedCount
UnreportedNotApplicableCount
NotApplicableCount
Each entry in the array is a structure containing:
Key (string between 1 and 200 characters)
Values (array containing a single string)
Type (string \"Equal\", \"NotEqual\", \"LessThan\", \"GreaterThan\")
" + "DescribeInstancePatchStatesForPatchGroupRequest$Filters": "Each entry in the array is a structure containing:
Key (string between 1 and 200 characters)
Values (array containing a single string)
Type (string \"Equal\", \"NotEqual\", \"LessThan\", \"GreaterThan\")
The value for the filter, must be an integer greater than or equal to 0.
" + "InstancePatchStateFilter$Values": "The value for the filter. Must be an integer greater than or equal to 0.
" } }, "InstancePatchStateList": { @@ -3163,7 +3163,7 @@ "InstancePatchStateOperatorType": { "base": null, "refs": { - "InstancePatchStateFilter$Type": "The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.
" + "InstancePatchStateFilter$Type": "The type of comparison that should be performed for the value.
" } }, "InstancePatchStatesList": { @@ -3175,17 +3175,17 @@ "InstanceTagName": { "base": null, "refs": { - "CommandInvocation$InstanceName": "The name of the invocation target. For EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.
" + "CommandInvocation$InstanceName": "The name of the invocation target. For EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.
The number of instances with patches installed by Patch Manager that have not been rebooted after the patch installation. The status of these instances is NON_COMPLIANT.
", - "DescribePatchGroupStateResult$InstancesWithInstalledRejectedPatches": "The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).
The number of instances where patches that are specified as \"Critical\" for compliance reporting in the patch baseline are not installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
The number of instances where patches that are specified as \"Security\" in a patch advisory are not installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
The number of instances with patches installed that are specified as other than \"Critical\" or \"Security\" but are not compliant with the patch baseline. The status of these instances is NON_COMPLIANT.
" + "DescribePatchGroupStateResult$InstancesWithInstalledPendingRebootPatches": "The number of instances with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these instances is NON_COMPLIANT.
The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).
The number of instances where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
The number of instances where patches that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
The number of instances with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these instances is NON_COMPLIANT.
The number of instances with missing patches from the patch baseline.
", "DescribePatchGroupStateResult$InstancesWithFailedPatches": "The number of instances with patches from the patch baseline that failed to install.
", "DescribePatchGroupStateResult$InstancesWithNotApplicablePatches": "The number of instances with patches that aren't applicable.
", - "DescribePatchGroupStateResult$InstancesWithUnreportedNotApplicablePatches": "The number of instances with NotApplicable patches beyond the supported limit, which are not reported by name to Systems Manager Inventory.
The number of instances with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
The total number of steps run in all specified AWS Regions and accounts for the current Automation execution.
", - "ProgressCounters$SuccessSteps": "The total number of steps that successfully completed in all specified AWS Regions and accounts for the current Automation execution.
", - "ProgressCounters$FailedSteps": "The total number of steps that failed to run in all specified AWS Regions and accounts for the current Automation execution.
", - "ProgressCounters$CancelledSteps": "The total number of steps that the system cancelled in all specified AWS Regions and accounts for the current Automation execution.
", - "ProgressCounters$TimedOutSteps": "The total number of steps that timed out in all specified AWS Regions and accounts for the current Automation execution.
", - "StepExecution$MaxAttempts": "The maximum number of tries to run the action of the step. The default value is 1.
" + "ProgressCounters$TotalSteps": "The total number of steps run in all specified Regions and accounts for the current Automation execution.
", + "ProgressCounters$SuccessSteps": "The total number of steps that successfully completed in all specified Regions and accounts for the current Automation execution.
", + "ProgressCounters$FailedSteps": "The total number of steps that failed to run in all specified Regions and accounts for the current Automation execution.
", + "ProgressCounters$CancelledSteps": "The total number of steps that the system cancelled in all specified Regions and accounts for the current Automation execution.
", + "ProgressCounters$TimedOutSteps": "The total number of steps that timed out in all specified Regions and accounts for the current Automation execution.
", + "StepExecution$MaxAttempts": "The maximum number of tries to run the action of the step. The default value is 1.
The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.
", + "base": "The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match.
", "refs": { } }, "InvalidActivationId": { - "base": "The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
", + "base": "The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
", "refs": { } }, "InvalidAggregatorException": { - "base": "The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
The request does not meet the regular expression requirement.
", + "base": "The request doesn't meet the regular expression requirement.
", "refs": { } }, "InvalidAssociation": { - "base": "The association is not valid or does not exist.
", + "base": "The association isn't valid or doesn't exist.
", "refs": { } }, "InvalidAssociationVersion": { - "base": "The version you specified is not valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.
The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.
The supplied parameters for invoking the specified Automation document are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
", + "base": "The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
", "refs": { } }, "InvalidAutomationSignalException": { - "base": "The signal is not valid for the current Automation execution.
", + "base": "The signal isn't valid for the current Automation execution.
", "refs": { } }, "InvalidAutomationStatusUpdateException": { - "base": "The specified update status operation is not valid.
", + "base": "The specified update status operation isn't valid.
", "refs": { } }, "InvalidCommandId": { - "base": "The specified command ID is not valid. Verify the ID and try again.
", + "base": "The specified command ID isn't valid. Verify the ID and try again.
", "refs": { } }, "InvalidDeleteInventoryParametersException": { - "base": "One or more of the parameters specified for the delete operation is not valid. Verify all parameters and try again.
", + "base": "One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.
", "refs": { } }, "InvalidDeletionIdException": { - "base": "The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.
", + "base": "The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.
", "refs": { } }, "InvalidDocument": { - "base": "The specified document does not exist.
", + "base": "The specified SSM document doesn't exist.
", "refs": { } }, "InvalidDocumentContent": { - "base": "The content for the document is not valid.
", + "base": "The content for the document isn't valid.
", "refs": { } }, @@ -3288,52 +3288,52 @@ } }, "InvalidDocumentSchemaVersion": { - "base": "The version of the document schema is not supported.
", + "base": "The version of the document schema isn't supported.
", "refs": { } }, "InvalidDocumentType": { - "base": "The document type is not valid. Valid document types are described in the DocumentType property.
The SSM document type isn't valid. Valid document types are described in the DocumentType property.
The document version is not valid or does not exist.
", + "base": "The document version isn't valid or doesn't exist.
", "refs": { } }, "InvalidFilter": { - "base": "The filter name is not valid. Verify the you entered the correct name and try again.
", + "base": "The filter name isn't valid. Verify the you entered the correct name and try again.
", "refs": { } }, "InvalidFilterKey": { - "base": "The specified key is not valid.
", + "base": "The specified key isn't valid.
", "refs": { } }, "InvalidFilterOption": { - "base": "The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
", + "base": "The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
", "refs": { } }, "InvalidFilterValue": { - "base": "The filter value is not valid. Verify the value and try again.
", + "base": "The filter value isn't valid. Verify the value and try again.
", "refs": { } }, "InvalidInstanceId": { - "base": "The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
", + "base": "The following problems can cause this exception:
You don't have permission to access the instance.
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance isn't in valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.
The specified filter value is not valid.
", + "base": "The specified filter value isn't valid.
", "refs": { } }, "InvalidInventoryGroupException": { - "base": "The specified inventory group is not valid.
", + "base": "The specified inventory group isn't valid.
", "refs": { } }, @@ -3343,57 +3343,57 @@ } }, "InvalidInventoryRequestException": { - "base": "The request is not valid.
", + "base": "The request isn't valid.
", "refs": { } }, "InvalidItemContentException": { - "base": "One or more content items is not valid.
", + "base": "One or more content items isn't valid.
", "refs": { } }, "InvalidKeyId": { - "base": "The query key ID is not valid.
", + "base": "The query key ID isn't valid.
", "refs": { } }, "InvalidNextToken": { - "base": "The specified token is not valid.
", + "base": "The specified token isn't valid.
", "refs": { } }, "InvalidNotificationConfig": { - "base": "One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.
", + "base": "One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service topic.
", "refs": { } }, "InvalidOptionException": { - "base": "The delete inventory option specified is not valid. Verify the option and try again.
", + "base": "The delete inventory option specified isn't valid. Verify the option and try again.
", "refs": { } }, "InvalidOutputFolder": { - "base": "The S3 bucket does not exist.
", + "base": "The S3 bucket doesn't exist.
", "refs": { } }, "InvalidOutputLocation": { - "base": "The output location is not valid or does not exist.
", + "base": "The output location isn't valid or doesn't exist.
", "refs": { } }, "InvalidParameters": { - "base": "You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.
", + "base": "You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
", "refs": { } }, "InvalidPermissionType": { - "base": "The permission type is not supported. Share is the only supported permission type.
", + "base": "The permission type isn't supported. Share is the only supported permission type.
", "refs": { } }, "InvalidPluginName": { - "base": "The plugin name is not valid.
", + "base": "The plugin name isn't valid.
", "refs": { } }, @@ -3403,27 +3403,27 @@ } }, "InvalidPolicyTypeException": { - "base": "The policy type is not supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
", + "base": "The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
", "refs": { } }, "InvalidResourceId": { - "base": "The resource ID is not valid. Verify that you entered the correct ID and try again.
", + "base": "The resource ID isn't valid. Verify that you entered the correct ID and try again.
", "refs": { } }, "InvalidResourceType": { - "base": "The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.
", + "base": "The resource type isn't valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.
", "refs": { } }, "InvalidResultAttributeException": { - "base": "The specified inventory item result attribute is not valid.
", + "base": "The specified inventory item result attribute isn't valid.
", "refs": { } }, "InvalidRole": { - "base": "The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.
", + "base": "The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Configuring Amazon SNS Notifications for Run Command in the Amazon Web Services Systems Manager User Guide.
", "refs": { } }, @@ -3433,17 +3433,17 @@ } }, "InvalidTarget": { - "base": "The target is not valid or does not exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
", + "base": "The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
", "refs": { } }, "InvalidTypeNameException": { - "base": "The parameter type name is not valid.
", + "base": "The parameter type name isn't valid.
", "refs": { } }, "InvalidUpdate": { - "base": "The update is not valid.
", + "base": "The update isn't valid.
", "refs": { } }, @@ -3497,7 +3497,7 @@ } }, "InventoryDeletionStatusItem": { - "base": "Status information returned by the DeleteInventory action.
Status information returned by the DeleteInventory operation.
Information about the delete operation.
", "refs": { - "DeleteInventoryResult$DeletionSummary": "A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the AWS Systems Manager User Guide.
", - "InventoryDeletionStatusItem$DeletionSummary": "Information about the delete operation. For more information about this summary, see Understanding the delete inventory summary in the AWS Systems Manager User Guide.
" + "DeleteInventoryResult$DeletionSummary": "A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the Amazon Web Services Systems Manager User Guide.
", + "InventoryDeletionStatusItem$DeletionSummary": "Information about the delete operation. For more information about this summary, see Understanding the delete inventory summary in the Amazon Web Services Systems Manager User Guide.
" } }, "InventoryDeletionSummaryItem": { @@ -3556,7 +3556,7 @@ "InventoryFilterValueList": { "base": null, "refs": { - "InventoryFilter$Values": "Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal
" + "InventoryFilter$Values": "Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal.
MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.
", - "InventoryResultItem$ContentHash": "MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.
" + "InventoryItem$ContentHash": "MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update.
", + "InventoryResultItem$ContentHash": "MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update.
" } }, "InventoryItemEntry": { @@ -3671,14 +3671,14 @@ "DeleteInventoryResult$TypeName": "The name of the inventory data type specified in the request.
", "InvalidItemContentException$TypeName": null, "InventoryDeletionStatusItem$TypeName": "The name of the inventory data type.
", - "InventoryItem$TypeName": "The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.
", - "InventoryItemSchema$TypeName": "The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.
", + "InventoryItem$TypeName": "The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.
The name of the inventory type. Default inventory item type names start with Amazon Web Services. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.
The name of the inventory result item type.
", "ItemContentMismatchException$TypeName": null, "ItemSizeLimitExceededException$TypeName": null, "ListInventoryEntriesRequest$TypeName": "The type of inventory item for which you want information.
", "ListInventoryEntriesResult$TypeName": "The type of inventory item returned by the request.
", - "ResultAttribute$TypeName": "Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation.
", + "ResultAttribute$TypeName": "Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation.
The type of filter.
The Exists filter must be used with aggregators. For more information, see Aggregating inventory data in the AWS Systems Manager User Guide.
The type of filter.
The Exists filter must be used with aggregators. For more information, see Aggregating inventory data in the Amazon Web Services Systems Manager User Guide.
Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:
DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.
DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.
" + "DeleteInventoryRequest$SchemaDeleteOption": "Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:
DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory operation for a version greater than the disabled version.
DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.
" } }, "InventoryTypeDisplayName": { @@ -3743,7 +3743,7 @@ } }, "InvocationDoesNotExist": { - "base": "The command ID and instance ID you specified did not match any invocations. Verify the command ID and the instance ID and try again.
", + "base": "The command ID and instance ID you specified didn't match any invocations. Verify the command ID and the instance ID and try again.
", "refs": { } }, @@ -3976,13 +3976,13 @@ } }, "LoggingInfo": { - "base": "Information about an S3 bucket to write instance-level logs to.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
Information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
The location in Amazon S3 where the task results are logged.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
Information about an S3 bucket to write task-level logs to.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
A structure containing information about an S3 bucket to write instance-level logs to.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
The new logging location in Amazon S3 to specify.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
The updated logging information in Amazon S3.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
Information about an S3 bucket to write task-level logs to.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
The new logging location in Amazon S3 to specify.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
The updated logging information in Amazon S3.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.
", + "CreateMaintenanceWindowRequest$AllowUnassociatedTargets": "Enables a maintenance window task to run on managed instances, even if you haven't registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.
", "GetMaintenanceWindowResult$AllowUnassociatedTargets": "Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
", "UpdateMaintenanceWindowRequest$AllowUnassociatedTargets": "Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
", "UpdateMaintenanceWindowResult$AllowUnassociatedTargets": "Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
" } }, "MaintenanceWindowAutomationParameters": { - "base": "The parameters for an AUTOMATION task type.
", + "base": "The parameters for an AUTOMATION task type.
The parameters for an AUTOMATION task type.
" + "MaintenanceWindowTaskInvocationParameters$Automation": "The parameters for an AUTOMATION task type.
The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
", - "GetMaintenanceWindowResult$Cutoff": "The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
", - "MaintenanceWindowIdentity$Cutoff": "The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
", - "UpdateMaintenanceWindowRequest$Cutoff": "The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
", - "UpdateMaintenanceWindowResult$Cutoff": "The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
" + "CreateMaintenanceWindowRequest$Cutoff": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
", + "GetMaintenanceWindowResult$Cutoff": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
", + "MaintenanceWindowIdentity$Cutoff": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
", + "UpdateMaintenanceWindowRequest$Cutoff": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
", + "UpdateMaintenanceWindowResult$Cutoff": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
" } }, "MaintenanceWindowDescription": { @@ -4098,19 +4098,19 @@ "MaintenanceWindowExecutionStatusDetails": { "base": null, "refs": { - "GetMaintenanceWindowExecutionResult$StatusDetails": "The details explaining the Status. Only available for certain status values.
", + "GetMaintenanceWindowExecutionResult$StatusDetails": "The details explaining the status. Not available for all status values.
", "GetMaintenanceWindowExecutionTaskInvocationResult$StatusDetails": "The details explaining the status. Details are only available for certain status values.
", - "GetMaintenanceWindowExecutionTaskResult$StatusDetails": "The details explaining the Status. Only available for certain status values.
", - "MaintenanceWindowExecution$StatusDetails": "The details explaining the Status. Only available for certain status values.
", - "MaintenanceWindowExecutionTaskIdentity$StatusDetails": "The details explaining the status of the task execution. Only available for certain status values.
", - "MaintenanceWindowExecutionTaskInvocationIdentity$StatusDetails": "The details explaining the status of the task invocation. Only available for certain Status values.
" + "GetMaintenanceWindowExecutionTaskResult$StatusDetails": "The details explaining the status. Not available for all status values.
", + "MaintenanceWindowExecution$StatusDetails": "The details explaining the status. Not available for all status values.
", + "MaintenanceWindowExecutionTaskIdentity$StatusDetails": "The details explaining the status of the task execution. Not available for all status values.
", + "MaintenanceWindowExecutionTaskInvocationIdentity$StatusDetails": "The details explaining the status of the task invocation. Not available for all status values.
" } }, "MaintenanceWindowExecutionTaskExecutionId": { "base": null, "refs": { "GetMaintenanceWindowExecutionTaskInvocationResult$ExecutionId": "The execution ID.
", - "MaintenanceWindowExecutionTaskInvocationIdentity$ExecutionId": "The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.
" + "MaintenanceWindowExecutionTaskInvocationIdentity$ExecutionId": "The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.
Filter used in the request. Supported filter keys are Name and Enabled.
", + "base": "Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use MaintenanceWindowFilter> include the following:
Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
", - "DescribeMaintenanceWindowExecutionTasksRequest$Filters": "Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
", - "DescribeMaintenanceWindowExecutionsRequest$Filters": "Each entry in the array is a structure containing:
Key (string, between 1 and 128 characters)
Values (array of strings, each string is between 1 and 256 characters)
The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.
", - "DescribeMaintenanceWindowTargetsRequest$Filters": "Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation.
", - "DescribeMaintenanceWindowTasksRequest$Filters": "Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
", - "DescribeMaintenanceWindowsRequest$Filters": "Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled.
" + "DescribeMaintenanceWindowExecutionTaskInvocationsRequest$Filters": "Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
Each entry in the array is a structure containing:
Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter.
Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2021-11-04T05:00:00Z.
Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId, and OwnerInformation.
Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled. For example, Name=MyMaintenanceWindow and Enabled=True.
The parameters for a LAMBDA task type.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.
The parameters for a LAMBDA task type.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.
The parameters for a LAMBDA task type.
" + "MaintenanceWindowTaskInvocationParameters$Lambda": "The parameters for a LAMBDA task type.
(Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points.
" + "MaintenanceWindowLambdaParameters$Qualifier": "(Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.
" } }, "MaintenanceWindowMaxResults": { @@ -4317,26 +4317,26 @@ "MaintenanceWindowOffset": { "base": null, "refs": { - "CreateMaintenanceWindowRequest$ScheduleOffset": "The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.
For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.
cron(30 23 ? * TUE#3 *)
If the schedule offset is 2, the maintenance window won't run until two days later.
The number of days to wait to run a maintenance window after the scheduled CRON expression date and time.
", - "MaintenanceWindowIdentity$ScheduleOffset": "The number of days to wait to run a maintenance window after the scheduled CRON expression date and time.
", - "UpdateMaintenanceWindowRequest$ScheduleOffset": "The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.
For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.
cron(30 23 ? * TUE#3 *)
If the schedule offset is 2, the maintenance window won't run until two days later.
The number of days to wait to run a maintenance window after the scheduled CRON expression date and time.
" + "CreateMaintenanceWindowRequest$ScheduleOffset": "The number of days to wait after the date and time specified by a cron expression before running the maintenance window.
For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.
cron(30 23 ? * TUE#3 *)
If the schedule offset is 2, the maintenance window won't run until two days later.
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
", + "MaintenanceWindowIdentity$ScheduleOffset": "The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
", + "UpdateMaintenanceWindowRequest$ScheduleOffset": "The number of days to wait after the date and time specified by a cron expression before running the maintenance window.
For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.
cron(30 23 ? * TUE#3 *)
If the schedule offset is 2, the maintenance window won't run until two days later.
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
" } }, "MaintenanceWindowResourceType": { "base": null, "refs": { - "DescribeMaintenanceWindowScheduleRequest$ResourceType": "The type of resource you want to retrieve information about. For example, \"INSTANCE\".
", - "DescribeMaintenanceWindowsForTargetRequest$ResourceType": "The type of resource you want to retrieve information about. For example, \"INSTANCE\".
", + "DescribeMaintenanceWindowScheduleRequest$ResourceType": "The type of resource you want to retrieve information about. For example, INSTANCE.
The type of resource you want to retrieve information about. For example, INSTANCE.
The type of target that is being registered with the maintenance window.
", "RegisterTargetWithMaintenanceWindowRequest$ResourceType": "The type of target being registered with the maintenance window.
" } }, "MaintenanceWindowRunCommandParameters": { - "base": "The parameters for a RUN_COMMAND task type.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
For Run Command tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.
The parameters for a RUN_COMMAND task type.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
For RUN_COMMAND tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.
The parameters for a RUN_COMMAND task type.
" + "MaintenanceWindowTaskInvocationParameters$RunCommand": "The parameters for a RUN_COMMAND task type.
The inputs for the STEP_FUNCTIONS task.
" + "MaintenanceWindowStepFunctionsParameters$Input": "The inputs for the STEP_FUNCTIONS task.
The name of the STEP_FUNCTIONS task.
" + "MaintenanceWindowStepFunctionsParameters$Name": "The name of the STEP_FUNCTIONS task.
The parameters for a STEP_FUNCTIONS task.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
For Step Functions tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.
The parameters for a STEP_FUNCTIONS task.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
For Step Functions tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.
The parameters for a STEP_FUNCTIONS task type.
" + "MaintenanceWindowTaskInvocationParameters$StepFunctions": "The parameters for a STEP_FUNCTIONS task type.
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
", - "CreateMaintenanceWindowRequest$EndDate": "The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
", - "GetMaintenanceWindowResult$StartDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.
", - "GetMaintenanceWindowResult$EndDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.
", + "CreateMaintenanceWindowRequest$StartDate": "The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.
", + "GetMaintenanceWindowResult$EndDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.
", "GetMaintenanceWindowResult$NextExecutionTime": "The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
", "MaintenanceWindowIdentity$EndDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
", "MaintenanceWindowIdentity$StartDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
", "MaintenanceWindowIdentity$NextExecutionTime": "The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
", "ScheduledWindowExecution$ExecutionTime": "The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.
", "UpdateMaintenanceWindowRequest$StartDate": "The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the Time Zone Database on the IANA website.
", - "UpdateMaintenanceWindowRequest$EndDate": "The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
", - "UpdateMaintenanceWindowResult$StartDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.
", - "UpdateMaintenanceWindowResult$EndDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.
" + "UpdateMaintenanceWindowRequest$EndDate": "The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.
", + "UpdateMaintenanceWindowResult$EndDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.
" } }, "MaintenanceWindowTarget": { @@ -4424,10 +4424,10 @@ "MaintenanceWindowTaskArn": { "base": null, "refs": { - "GetMaintenanceWindowExecutionTaskResult$TaskArn": "The ARN of the task that ran.
", - "GetMaintenanceWindowTaskResult$TaskArn": "The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.
", - "MaintenanceWindowExecutionTaskIdentity$TaskArn": "The ARN of the task that ran.
", - "MaintenanceWindowTask$TaskArn": "The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.
The Amazon Resource Name (ARN) of the task that ran.
", + "GetMaintenanceWindowTaskResult$TaskArn": "The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.
The Amazon Resource Name (ARN) of the task that ran.
", + "MaintenanceWindowTask$TaskArn": "The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.
The ARN of the task to run.
", "UpdateMaintenanceWindowTaskRequest$TaskArn": "The task ARN to modify.
", "UpdateMaintenanceWindowTaskResult$TaskArn": "The updated task ARN value.
" @@ -4451,7 +4451,7 @@ "refs": { "GetMaintenanceWindowTaskResult$TaskInvocationParameters": "The parameters to pass to the task when it runs.
", "RegisterTaskWithMaintenanceWindowRequest$TaskInvocationParameters": "The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
", - "UpdateMaintenanceWindowTaskRequest$TaskInvocationParameters": "The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.
The updated parameter values.
" } }, @@ -4499,7 +4499,7 @@ "MaintenanceWindowTaskParametersList": { "base": null, "refs": { - "GetMaintenanceWindowExecutionTaskResult$TaskParameters": "The parameters passed to the task when it was run.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
The map has the following format:
Key: string, between 1 and 255 characters
Value: an array of strings, each string is between 1 and 255 characters
" + "GetMaintenanceWindowExecutionTaskResult$TaskParameters": "The parameters passed to the task when it was run.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
The map has the following format:
Key: string, between 1 and 255 characters
Value: an array of strings, each between 1 and 255 characters
Retrieves the task type for a maintenance window. Task types include the following: LAMBDA, STEP_FUNCTIONS, AUTOMATION, RUN_COMMAND.
", + "GetMaintenanceWindowExecutionTaskInvocationResult$TaskType": "Retrieves the task type for a maintenance window.
", "GetMaintenanceWindowExecutionTaskResult$Type": "The type of task that was run.
", "GetMaintenanceWindowTaskResult$TaskType": "The type of task to run.
", "MaintenanceWindowExecutionTaskIdentity$TaskType": "The type of task that ran.
", "MaintenanceWindowExecutionTaskInvocationIdentity$TaskType": "The task type.
", - "MaintenanceWindowTask$Type": "The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTIONS.
", + "MaintenanceWindowTask$Type": "The type of task.
", "RegisterTaskWithMaintenanceWindowRequest$TaskType": "The type of task being registered.
" } }, @@ -4558,24 +4558,24 @@ "MaxConcurrency": { "base": null, "refs": { - "AssociationDescription$MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
", - "AssociationVersionInfo$MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
", - "AutomationExecution$MaxConcurrency": "The MaxConcurrency value specified by the user when the execution started.
", - "AutomationExecutionMetadata$MaxConcurrency": "The MaxConcurrency value specified by the user when starting the Automation.
", - "Command$MaxConcurrency": "The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.
", - "CreateAssociationBatchRequestEntry$MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
", - "CreateAssociationRequest$MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
", + "AssociationDescription$MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
The MaxConcurrency value specified by the user when the execution started.
The MaxConcurrency value specified by the user when starting the automation.
The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
The defined maximum number of task executions that could be run in parallel.
", - "GetMaintenanceWindowTaskResult$MaxConcurrency": "The maximum number of targets allowed to run this task in parallel.
For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value does not affect the running of your task and can be ignored.
The maximum number of targets allowed to run this task in parallel.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
The maximum number of targets this task can be run for, in parallel.
", - "RegisterTaskWithMaintenanceWindowRequest$MaxConcurrency": "The maximum number of targets this task can be run for in parallel.
For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.
The maximum number of targets this task can be run for in parallel.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.
(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the AWS Systems Manager User Guide.
", - "StartAutomationExecutionRequest$MaxConcurrency": "The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.
", - "TargetLocation$TargetLocationMaxConcurrency": "The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently.
", - "UpdateAssociationRequest$MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
", - "UpdateMaintenanceWindowTaskRequest$MaxConcurrency": "The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.
For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value does not affect the running of your task and can be ignored.
The updated MaxConcurrency value.
" + "SendCommandRequest$MaxConcurrency": "(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.
The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.
The maximum number of Regions and accounts allowed to run the Automation concurrently.
", + "UpdateAssociationRequest$MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
The updated MaxConcurrency value.
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
", - "AssociationVersionInfo$MaxErrors": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
", + "AssociationDescription$MaxErrors": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
The MaxErrors value specified by the user when the execution started.
", - "AutomationExecutionMetadata$MaxErrors": "The MaxErrors value specified by the user when starting the Automation.
", - "Command$MaxErrors": "The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.
", - "CreateAssociationBatchRequestEntry$MaxErrors": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
", - "CreateAssociationRequest$MaxErrors": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
", + "AutomationExecutionMetadata$MaxErrors": "The MaxErrors value specified by the user when starting the automation.
The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
", - "GetMaintenanceWindowTaskResult$MaxErrors": "The maximum number of errors allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value does not affect the running of your task and can be ignored.
The maximum number of errors allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
The maximum number of errors allowed before this task stops being scheduled.
", - "RegisterTaskWithMaintenanceWindowRequest$MaxErrors": "The maximum number of errors allowed before this task stops being scheduled.
For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.
The maximum number of errors allowed before this task stops being scheduled.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.
The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the AWS Systems Manager User Guide.
", + "SendCommandRequest$MaxErrors": "The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.
The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.
Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.
", "TargetLocation$TargetLocationMaxErrors": "The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
", - "UpdateAssociationRequest$MaxErrors": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
", - "UpdateMaintenanceWindowTaskRequest$MaxErrors": "The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value does not affect the running of your task and can be ignored.
The updated MaxErrors value.
" + "UpdateAssociationRequest$MaxErrors": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
The updated MaxErrors value.
A summary of resources that are not compliant. The summary is organized according to resource type.
", + "base": "A summary of resources that aren't compliant. The summary is organized according to resource type.
", "refs": { "ComplianceSummaryItem$NonCompliantSummary": "A list of NON_COMPLIANT items for the specified compliance type.
", "ResourceComplianceSummaryItem$NonCompliantSummary": "A list of items that aren't compliant for the resource.
" @@ -4818,32 +4818,32 @@ "NotificationEventList": { "base": null, "refs": { - "NotificationConfig$NotificationEvents": "The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the AWS Systems Manager User Guide.
" + "NotificationConfig$NotificationEvents": "The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
" } }, "NotificationType": { "base": null, "refs": { - "NotificationConfig$NotificationType": "Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
" + "NotificationConfig$NotificationType": "The type of notification.
Command: Receive notification when the status of a command changes.
Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
The operating system rule used by the patch baseline override.
", - "CreatePatchBaselineRequest$OperatingSystem": "Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
", + "CreatePatchBaselineRequest$OperatingSystem": "Defines the operating system the patch baseline applies to. The default value is WINDOWS.
The operating system type for which to list patches.
", "GetDefaultPatchBaselineRequest$OperatingSystem": "Returns the default patch baseline for the specified operating system.
", "GetDefaultPatchBaselineResult$OperatingSystem": "The operating system for the returned patch baseline.
", "GetPatchBaselineForPatchGroupRequest$OperatingSystem": "Returns he operating system rule specified for patch groups using the patch baseline.
", "GetPatchBaselineForPatchGroupResult$OperatingSystem": "The operating system rule specified for patch groups using the patch baseline.
", "GetPatchBaselineResult$OperatingSystem": "Returns the operating system specified for the patch baseline.
", - "PatchBaselineIdentity$OperatingSystem": "Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
", + "PatchBaselineIdentity$OperatingSystem": "Defines the operating system the patch baseline applies to. The default value is WINDOWS.
The operating system rule used by the updated patch baseline.
" } }, "OpsAggregator": { - "base": "One or more aggregators for viewing counts of OpsItems using different dimensions such as Source, CreatedTime, or Source and CreatedTime, to name a few.
One or more aggregators for viewing counts of OpsData using different dimensions such as Source, CreatedTime, or Source and CreatedTime, to name a few.
Optional aggregators that return counts of OpsItems based on one or more expressions.
", - "OpsAggregator$Aggregators": "A nested aggregator for viewing counts of OpsItems.
" + "GetOpsSummaryRequest$Aggregators": "Optional aggregators that return counts of OpsData based on one or more expressions.
", + "OpsAggregator$Aggregators": "A nested aggregator for viewing counts of OpsData.
" } }, "OpsAggregatorType": { "base": null, "refs": { - "OpsAggregator$AggregatorType": "Either a Range or Count aggregator for limiting an OpsItem summary.
" + "OpsAggregator$AggregatorType": "Either a Range or Count aggregator for limiting an OpsData summary.
The name of an OpsItem attribute on which to limit the count of OpsItems.
" + "OpsAggregator$AttributeName": "The name of an OpsData attribute on which to limit the count of OpsData.
" } }, "OpsDataTypeName": { "base": null, "refs": { - "OpsAggregator$TypeName": "The data type name to use for viewing counts of OpsItems.
", - "OpsResultAttribute$TypeName": "Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, AWS:OpsItemTrendline, or AWS:ComplianceSummary.
" + "OpsAggregator$TypeName": "The data type name to use for viewing counts of OpsData.
", + "OpsResultAttribute$TypeName": "Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, AWS:OpsItemTrendline, or AWS:ComplianceSummary.
The OpsItem summaries result item.
", + "base": "The OpsData summary.
", "refs": { "OpsEntityItemMap$value": null } @@ -4913,7 +4913,7 @@ "OpsEntityItemCaptureTime": { "base": null, "refs": { - "OpsEntityItem$CaptureTime": "The time OpsItem data was captured.
" + "OpsEntityItem$CaptureTime": "The time the OpsData was captured.
" } }, "OpsEntityItemEntry": { @@ -4925,7 +4925,7 @@ "OpsEntityItemEntryList": { "base": null, "refs": { - "OpsEntityItem$Content": "The detailed data content for an OpsItem summaries result item.
" + "OpsEntityItem$Content": "The details of an OpsData summary.
" } }, "OpsEntityItemKey": { @@ -4943,11 +4943,11 @@ "OpsEntityList": { "base": null, "refs": { - "GetOpsSummaryResult$Entities": "The list of aggregated and filtered OpsItems.
" + "GetOpsSummaryResult$Entities": "The list of aggregated and filtered OpsData.
" } }, "OpsFilter": { - "base": "A filter for viewing OpsItem summaries.
", + "base": "A filter for viewing OpsData summaries.
", "refs": { "OpsFilterList$member": null } @@ -4961,7 +4961,7 @@ "OpsFilterList": { "base": null, "refs": { - "GetOpsSummaryRequest$Filters": "Optional filters used to scope down the returned OpsItems.
", + "GetOpsSummaryRequest$Filters": "Optional filters used to scope down the returned OpsData.
", "OpsAggregator$Filters": "The aggregator filters.
" } }, @@ -4984,7 +4984,7 @@ } }, "OpsItem": { - "base": "Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
", + "base": "Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
", "refs": { "GetOpsItemResponse$OpsItem": "The OpsItem.
" } @@ -5122,7 +5122,7 @@ "OpsItemFilters": { "base": null, "refs": { - "DescribeOpsItemsRequest$OpsItemFilters": "One or more filters to limit the response.
Key: CreatedTime
Operations: GreaterThan, LessThan
Key: LastModifiedBy
Operations: Contains, Equals
Key: LastModifiedTime
Operations: GreaterThan, LessThan
Key: Priority
Operations: Equals
Key: Source
Operations: Contains, Equals
Key: Status
Operations: Equals
Key: Title
Operations: Contains
Key: OperationalData*
Operations: Equals
Key: OperationalDataKey
Operations: Equals
Key: OperationalDataValue
Operations: Equals, Contains
Key: OpsItemId
Operations: Equals
Key: ResourceId
Operations: Contains
Key: AutomationId
Operations: Equals
*If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {\"key\":\"key_name\",\"value\":\"a_value\"}
" + "DescribeOpsItemsRequest$OpsItemFilters": "One or more filters to limit the response.
Key: CreatedTime
Operations: GreaterThan, LessThan
Key: LastModifiedBy
Operations: Contains, Equals
Key: LastModifiedTime
Operations: GreaterThan, LessThan
Key: Priority
Operations: Equals
Key: Source
Operations: Contains, Equals
Key: Status
Operations: Equals
Key: Title*
Operations: Equals,Contains
Key: OperationalData**
Operations: Equals
Key: OperationalDataKey
Operations: Equals
Key: OperationalDataValue
Operations: Equals, Contains
Key: OpsItemId
Operations: Equals
Key: ResourceId
Operations: Contains
Key: AutomationId
Operations: Equals
*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.
**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {\"key\":\"key_name\",\"value\":\"a_value\"}
" } }, "OpsItemId": { @@ -5178,17 +5178,17 @@ "base": null, "refs": { "CreateOpsItemRequest$Notifications": "The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
", - "OpsItem$Notifications": "The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
", + "OpsItem$Notifications": "The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
", "UpdateOpsItemRequest$Notifications": "The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
" } }, "OpsItemOperationalData": { "base": null, "refs": { - "CreateOpsItemRequest$OperationalData": "Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).
Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).
Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
Operational data is custom data that provides useful reference details about the OpsItem.
", - "UpdateOpsItemRequest$OperationalData": "Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).
Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
The association was not found using the parameters you specified in the call. Verify the information and try again.
", + "base": "The association wasn't found using the parameters you specified in the call. Verify the information and try again.
", "refs": { } }, "OpsItemRelatedItemAssociationResourceType": { "base": null, "refs": { - "AssociateOpsItemRelatedItemRequest$ResourceType": "The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:
AWS::SSMIncidents::IncidentRecord: an Incident Manager incident. Incident Manager is a capability of AWS Systems Manager.
AWS::SSM::Document: a Systems Manager (SSM) document.
The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:
AWS::SSMIncidents::IncidentRecord: an Incident Manager incident. Incident Manager is a capability of Amazon Web Services Systems Manager.
AWS::SSM::Document: a Systems Manager (SSM) document.
The resource type.
" } }, "OpsItemRelatedItemAssociationResourceUri": { "base": null, "refs": { - "AssociateOpsItemRelatedItemRequest$ResourceUri": "The Amazon Resource Name (ARN) of the AWS resource that you want to associate with the OpsItem.
", + "AssociateOpsItemRelatedItemRequest$ResourceUri": "The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.
", "OpsItemRelatedItemAlreadyExistsException$ResourceUri": null, "OpsItemRelatedItemSummary$ResourceUri": "The Amazon Resource Name (ARN) of the related-item resource.
" } @@ -5319,17 +5319,17 @@ "OpsItemSource": { "base": null, "refs": { - "CreateOpsItemRequest$Source": "The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
The source name can't contain the following strings: aws, amazon, and amzn.
The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
The source name can't contain the following strings: aws, amazon, and amzn.
The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
", - "OpsItemSummary$Source": "The impacted AWS resource.
" + "OpsItemSummary$Source": "The impacted Amazon Web Services resource.
" } }, "OpsItemStatus": { "base": null, "refs": { - "OpsItem$Status": "The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.
The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
The OpsItem status. Status can be Open, In Progress, or Resolved.
The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.
The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
The OpsMetadata object does not exist.
", + "base": "The OpsMetadata object doesn't exist.
", "refs": { } }, @@ -5461,7 +5461,7 @@ "OpsResultAttributeList": { "base": null, "refs": { - "GetOpsSummaryRequest$ResultAttributes": "The OpsItem data type to return.
" + "GetOpsSummaryRequest$ResultAttributes": "The OpsData data type to return.
" } }, "OutputSource": { @@ -5485,12 +5485,12 @@ "OwnerInformation": { "base": null, "refs": { - "GetMaintenanceWindowExecutionTaskInvocationResult$OwnerInformation": "User-provided value to be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.
", + "GetMaintenanceWindowExecutionTaskInvocationResult$OwnerInformation": "User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window.
", "InstancePatchState$OwnerInformation": "Placeholder information. This field will always be empty in the current release of the service.
", - "MaintenanceWindowExecutionTaskInvocationIdentity$OwnerInformation": "User-provided value that was specified when the target was registered with the maintenance window. This was also included in any CloudWatch events raised during the task invocation.
", - "MaintenanceWindowTarget$OwnerInformation": "A user-provided value that will be included in any CloudWatch events that are raised while running tasks for these targets in this maintenance window.
", - "RegisterTargetWithMaintenanceWindowRequest$OwnerInformation": "User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.
", - "UpdateMaintenanceWindowTargetRequest$OwnerInformation": "User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.
", + "MaintenanceWindowExecutionTaskInvocationIdentity$OwnerInformation": "User-provided value that was specified when the target was registered with the maintenance window. This was also included in any Amazon CloudWatch Events events raised during the task invocation.
", + "MaintenanceWindowTarget$OwnerInformation": "A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.
", + "RegisterTargetWithMaintenanceWindowRequest$OwnerInformation": "User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.
", + "UpdateMaintenanceWindowTargetRequest$OwnerInformation": "User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.
", "UpdateMaintenanceWindowTargetResult$OwnerInformation": "The updated owner.
" } }, @@ -5500,14 +5500,14 @@ "DeleteParameterRequest$Name": "The name of the parameter to delete.
", "GetParameterHistoryRequest$Name": "The name of the parameter for which you want to review history.
", "GetParameterRequest$Name": "The name of the parameter you want to query.
", - "GetParametersByPathRequest$Path": "The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33
The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33
The parameter name on which you want to attach one or more labels.
", "Parameter$Name": "The name of the parameter.
", "ParameterHistory$Name": "The name of the parameter.
", "ParameterMetadata$Name": "The parameter name.
", "ParameterNameList$member": null, - "PutParameterRequest$Name": "The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13
Naming Constraints:
Parameter names are case sensitive.
A parameter name must be unique within an AWS Region
A parameter name can't be prefixed with \"aws\" or \"ssm\" (case-insensitive).
Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-
In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: /Dev/Production/East/Project-ABC/MyParameter
A parameter name can't include spaces.
Parameter hierarchies are limited to a maximum depth of fifteen levels.
For additional information about valid values for parameter names, see Creating Systems Manager parameters in the AWS Systems Manager User Guide.
The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:
arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName
The parameter name of which you want to delete one or more labels.
" + "PutParameterRequest$Name": "The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13
Naming Constraints:
Parameter names are case sensitive.
A parameter name must be unique within an Region
A parameter name can't be prefixed with \"aws\" or \"ssm\" (case-insensitive).
Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-
In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: /Dev/Production/East/Project-ABC/MyParameter
A parameter name can't include spaces.
Parameter hierarchies are limited to a maximum depth of fifteen levels.
For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.
The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:
arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName
The name of the parameter from which you want to delete one or more labels.
" } }, "PSParameterSelector": { @@ -5532,12 +5532,12 @@ "Parameter$Version": "The parameter version.
", "ParameterHistory$Version": "The parameter version.
", "ParameterMetadata$Version": "The parameter version.
", - "PutParameterResult$Version": "The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.
", - "UnlabelParameterVersionRequest$ParameterVersion": "The specific version of the parameter which you want to delete one or more labels from. If it is not present, the call will fail.
" + "PutParameterResult$Version": "The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API operations or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.
", + "UnlabelParameterVersionRequest$ParameterVersion": "The specific version of the parameter which you want to delete one or more labels from. If it isn't present, the call will fail.
" } }, "Parameter": { - "base": "An Systems Manager parameter in Parameter Store.
", + "base": "An Amazon Web Services Systems Manager parameter in Parameter Store.
", "refs": { "GetParameterResult$Parameter": "Information about a parameter.
", "ParameterList$member": null @@ -5554,7 +5554,7 @@ "Parameter$DataType": "The data type of the parameter, such as text or aws:ec2:image. The default is text.
The data type of the parameter, such as text or aws:ec2:image. The default is text.
The data type of the parameter, such as text or aws:ec2:image. The default is text.
The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.
The following data type values are supported.
text
aws:ec2:image
When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.
The data type for a String parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.
The following data type values are supported.
text
aws:ec2:image
When you create a String parameter and specify aws:ec2:image, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your account. For more information, see Native parameter support for Amazon Machine Image (AMI) IDs in the Amazon Web Services Systems Manager User Guide.
Information about the parameter.
", "ParameterMetadata$Description": "Description of the parameter actions.
", - "PutParameterRequest$Description": "Information about the parameter that you want to add to the system. Optional but recommended.
Do not enter personally identifiable information in this field.
Information about the parameter that you want to add to the system. Optional but recommended.
Don't enter personally identifiable information in this field.
The ID of the query key used for this parameter.
", "ParameterMetadata$KeyId": "The ID of the query key used for this parameter.
", - "PutParameterRequest$KeyId": "The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.
If you don't specify a key ID, the system uses the default key associated with your AWS account.
To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Either the default KMS key automatically assigned to your account or a custom key. Required for parameters that use the SecureString data type.
If you don't specify a key ID, the system uses the default key associated with your account.
To use your default KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
One or more labels to attach to the specified parameter version.
", - "LabelParameterVersionResult$InvalidLabels": "The label does not meet the requirements. For information about parameter label requirements, see Labeling parameters in the AWS Systems Manager User Guide.
", + "LabelParameterVersionResult$InvalidLabels": "The label doesn't meet the requirements. For information about parameter label requirements, see Labeling parameters in the Amazon Web Services Systems Manager User Guide.
", "ParameterHistory$Labels": "Labels assigned to the parameter version.
", "UnlabelParameterVersionRequest$Labels": "One or more labels to delete from the specified parameter version.
", "UnlabelParameterVersionResult$RemovedLabels": "A list of all labels deleted from the parameter.
", - "UnlabelParameterVersionResult$InvalidLabels": "The labels that are not attached to the given parameter version.
" + "UnlabelParameterVersionResult$InvalidLabels": "The labels that aren't attached to the given parameter version.
" } }, "ParameterLimitExceeded": { - "base": "You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try again.
", + "base": "You have exceeded the number of parameters for this account. Delete one or more parameters and try again.
", "refs": { } }, @@ -5621,7 +5621,7 @@ } }, "ParameterMaxVersionLimitExceeded": { - "base": "Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a label attached to it, Parameter Store will not delete the version and instead presents this error message:
An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.
This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the AWS Systems Manager User Guide.
", + "base": "Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a label attached to it, Parameter Store won't delete the version and instead presents this error message:
An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.
This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the Amazon Web Services Systems Manager User Guide.
", "refs": { } }, @@ -5648,31 +5648,31 @@ "refs": { "DeleteParametersRequest$Names": "The names of the parameters to delete.
", "DeleteParametersResult$DeletedParameters": "The names of the deleted parameters.
", - "DeleteParametersResult$InvalidParameters": "The names of parameters that weren't deleted because the parameters are not valid.
", + "DeleteParametersResult$InvalidParameters": "The names of parameters that weren't deleted because the parameters aren't valid.
", "GetParametersRequest$Names": "Names of the parameters for which you want to query information.
", - "GetParametersResult$InvalidParameters": "A list of parameters that are not formatted correctly or do not run during an execution.
" + "GetParametersResult$InvalidParameters": "A list of parameters that aren't formatted correctly or don't run during an execution.
" } }, "ParameterNotFound": { - "base": "The parameter could not be found. Verify the name and try again.
", + "base": "The parameter couldn't be found. Verify the name and try again.
", "refs": { } }, "ParameterPatternMismatchException": { - "base": "The parameter name is not valid.
", + "base": "The parameter name isn't valid.
", "refs": { } }, "ParameterPolicies": { "base": null, "refs": { - "PutParameterRequest$Policies": "One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:
Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.
NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.
All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.
" + "PutParameterRequest$Policies": "One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a capability of Amazon Web Services Systems Manager supports the following policy types:
Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.
NoChangeNotification: This policy triggers a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.
All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.
" } }, "ParameterPolicyList": { "base": null, "refs": { - "ParameterHistory$Policies": "Information about the policies assigned to a parameter.
Assigning parameter policies in the AWS Systems Manager User Guide.
", + "ParameterHistory$Policies": "Information about the policies assigned to a parameter.
Assigning parameter policies in the Amazon Web Services Systems Manager User Guide.
", "ParameterMetadata$Policies": "A list of policies associated with a parameter.
" } }, @@ -5685,7 +5685,7 @@ "ParameterStringFilterKey": { "base": null, "refs": { - "ParameterStringFilter$Key": "The name of the filter.
The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API actions. However, not all of the pattern values listed for Key can be used with both actions.
For DescribeActions, all of the listed patterns are valid, with the exception of Label.
For GetParametersByPath, the following patterns listed for Key are not valid: tag, Name, Path, and Tier.
For examples of CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the AWS Systems Manager User Guide.
The name of the filter.
The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for Key can be used with both operations.
For DescribeActions, all of the listed patterns are valid, with the exception of Label.
For GetParametersByPath, the following patterns listed for Key aren't valid: tag, Name, Path, and Tier.
For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.
" } }, "ParameterStringFilterList": { @@ -5718,7 +5718,7 @@ "refs": { "ParameterHistory$Tier": "The parameter tier.
", "ParameterMetadata$Tier": "The parameter tier.
", - "PutParameterRequest$Tier": "The parameter tier to assign to a parameter.
Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost.
Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the AWS Systems Manager User Guide.
You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.
Using the Default Tier Configuration
In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you do not specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.
The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:
Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.
Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.
If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.
This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.
Options that require an advanced parameter include the following:
The content size of the parameter is more than 4 KB.
The parameter uses a parameter policy.
More than 10,000 parameters already exist in your AWS account in the current Region.
For more information about configuring the default tier option, see Specifying a default parameter tier in the AWS Systems Manager User Guide.
", + "PutParameterRequest$Tier": "The parameter tier to assign to a parameter.
Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an account. Standard parameters are offered at no additional cost.
Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the Amazon Web Services Systems Manager User Guide.
You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.
Using the Default Tier Configuration
In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.
The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:
Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.
Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.
If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.
This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.
Options that require an advanced parameter include the following:
The content size of the parameter is more than 4 KB.
The parameter uses a parameter policy.
More than 10,000 parameters already exist in your account in the current Region.
For more information about configuring the default tier option, see Specifying a default parameter tier in the Amazon Web Services Systems Manager User Guide.
", "PutParameterResult$Tier": "The tier assigned to the parameter.
" } }, @@ -5728,7 +5728,7 @@ "Parameter$Type": "The type of parameter. Valid values include the following: String, StringList, and SecureString.
The type of parameter used.
", "ParameterMetadata$Type": "The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.
The type of parameter that you want to add to the system.
SecureString is not currently supported for AWS CloudFormation templates.
Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
Specifying a parameter type is not required when updating a parameter. You must specify a parameter type when creating a parameter.
The type of parameter that you want to add to the system.
SecureString isn't currently supported for CloudFormation templates.
Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.
The specified parameter version was not found. Verify the parameter name and version, and try again.
", + "base": "The specified parameter version wasn't found. Verify the parameter name and version, and try again.
", "refs": { } }, @@ -5762,9 +5762,9 @@ "Command$Parameters": "The parameter values to be inserted in the document when running the command.
", "CreateAssociationBatchRequestEntry$Parameters": "A description of the parameters for a document.
", "CreateAssociationRequest$Parameters": "The parameters for the runtime configuration of the document.
", - "MaintenanceWindowRunCommandParameters$Parameters": "The parameters for the RUN_COMMAND task execution.
", + "MaintenanceWindowRunCommandParameters$Parameters": "The parameters for the RUN_COMMAND task execution.
The required and optional parameters specified in the document being run.
", - "UpdateAssociationRequest$Parameters": "The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
" + "UpdateAssociationRequest$Parameters": "The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.
The action for Patch Manager to take on patches included in the RejectedPackages list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
", - "CreatePatchBaselineRequest$RejectedPatchesAction": "The action for Patch Manager to take on patches included in the RejectedPackages list.
ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.
BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
", - "UpdatePatchBaselineRequest$RejectedPatchesAction": "The action for Patch Manager to take on patches included in the RejectedPackages list.
ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.
BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
" + "BaselineOverride$RejectedPatchesAction": "The action for Patch Manager to take on patches included in the RejectedPackages list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
The action for Patch Manager to take on patches included in the RejectedPackages list.
ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.
BLOCK : Packages in the RejectedPatches list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
The action for Patch Manager to take on patches included in the RejectedPackages list.
ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.
BLOCK : Packages in the RejectedPatches list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
An array of PatchBaselineIdentity elements.
" + "DescribePatchBaselinesResult$BaselineIdentities": "An array of PatchBaselineIdentity elements.
The classification of the patch. For example, SecurityUpdates, Updates, or CriticalUpdates.
The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
" + "PatchComplianceData$Classification": "The classification of the patch, such as SecurityUpdates, Updates, and CriticalUpdates.
Each entry in the array is a structure containing:
Title (string)
KBId (string)
Classification (string)
Severity (string)
State (string, such as \"INSTALLED\" or \"FAILED\")
InstalledTime (DateTime)
InstalledBy (string)
" + "DescribeInstancePatchesResult$Patches": "Each entry in the array is a structure containing:
Title (string)
KBId (string)
Classification (string)
Severity (string)
State (string, such as \"INSTALLED\" or \"FAILED\")
InstalledTime (DateTime)
InstalledBy (string)
The state of the patch on the instance, such as INSTALLED or FAILED.
For descriptions of each patch state, see About patch compliance in the AWS Systems Manager User Guide.
" + "PatchComplianceData$State": "The state of the patch on the instance, such as INSTALLED or FAILED.
For descriptions of each patch state, see About patch compliance in the Amazon Web Services Systems Manager User Guide.
" } }, "PatchComplianceLevel": { "base": null, "refs": { "BaselineOverride$ApprovedPatchesComplianceLevel": "Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation.
", - "CreatePatchBaselineRequest$ApprovedPatchesComplianceLevel": "Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED.
", + "CreatePatchBaselineRequest$ApprovedPatchesComplianceLevel": "Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED.
Returns the specified compliance severity level for approved patches in the patch baseline.
", "PatchRule$ComplianceLevel": "A compliance severity level for all approved patches in a patch baseline.
", "PatchStatus$ComplianceLevel": "The compliance severity level for a patch.
", @@ -5938,13 +5938,13 @@ "PatchCriticalNonCompliantCount": { "base": null, "refs": { - "InstancePatchState$CriticalNonCompliantCount": "The number of instances where patches that are specified as \"Critical\" for compliance reporting in the patch baseline are not installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
The number of instances where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, EXPLICIT_REJECTED).
" + "PatchStatus$DeploymentStatus": "The approval status of a patch.
" } }, "PatchDescription": { @@ -5966,7 +5966,7 @@ } }, "PatchFilter": { - "base": "Defines which patches should be included in a patch baseline.
A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY. The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are [\"Office 2013\", \"Office 2016\"], then the filter accepts all patches where product name is either \"Office 2013\" or \"Office 2016\". The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.
You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.
Defines which patches should be included in a patch baseline.
A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY.
The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are [\"Office 2013\", \"Office 2016\"], then the filter accepts all patches where product name is either \"Office 2013\" or \"Office 2016\". The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.
You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.
The name of the patch group the managed instance belongs to.
", "PatchGroupList$member": null, "PatchGroupPatchBaselineMapping$PatchGroup": "The name of the patch group registered with the patch baseline.
", - "RegisterPatchBaselineForPatchGroupRequest$PatchGroup": "The name of the patch group that should be registered with the patch baseline.
", + "RegisterPatchBaselineForPatchGroupRequest$PatchGroup": "The name of the patch group to be registered with the patch baseline.
", "RegisterPatchBaselineForPatchGroupResult$PatchGroup": "The name of the patch group registered with the patch baseline.
" } }, @@ -6037,27 +6037,27 @@ "PatchGroupPatchBaselineMappingList": { "base": null, "refs": { - "DescribePatchGroupsResult$Mappings": "Each entry in the array contains:
PatchGroup: string (between 1 and 256 characters, Regex: ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$)
PatchBaselineIdentity: A PatchBaselineIdentity element.
" + "DescribePatchGroupsResult$Mappings": "Each entry in the array contains:
PatchGroup: string (between 1 and 256 characters. Regex: ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$)
PatchBaselineIdentity: A PatchBaselineIdentity element.
The ID of the patch. Applies to Windows patches only.
This ID is not the same as the Microsoft Knowledge Base ID.
The ID of the patch. Applies to Windows patches only.
This ID isn't the same as the Microsoft Knowledge Base ID.
A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
", - "BaselineOverride$RejectedPatches": "A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
", - "CreatePatchBaselineRequest$ApprovedPatches": "A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
", - "CreatePatchBaselineRequest$RejectedPatches": "A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
", + "BaselineOverride$ApprovedPatches": "A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
", + "BaselineOverride$RejectedPatches": "A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
", + "CreatePatchBaselineRequest$ApprovedPatches": "A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
", + "CreatePatchBaselineRequest$RejectedPatches": "A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
", "GetPatchBaselineResult$ApprovedPatches": "A list of explicitly approved patches for the baseline.
", "GetPatchBaselineResult$RejectedPatches": "A list of explicitly rejected patches for the baseline.
", - "UpdatePatchBaselineRequest$ApprovedPatches": "A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
", - "UpdatePatchBaselineRequest$RejectedPatches": "A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
", + "UpdatePatchBaselineRequest$ApprovedPatches": "A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
", + "UpdatePatchBaselineRequest$RejectedPatches": "A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
", "UpdatePatchBaselineResult$ApprovedPatches": "A list of explicitly approved patches for the baseline.
", "UpdatePatchBaselineResult$RejectedPatches": "A list of explicitly rejected patches for the baseline.
" } @@ -6083,7 +6083,7 @@ "PatchInstalledRejectedCount": { "base": null, "refs": { - "InstancePatchState$InstalledRejectedCount": "The number of patches installed on an instance that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).
The number of patches installed on an instance that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).
The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
The type of patching operation that was performed: or
SCAN assesses the patch compliance state.
INSTALL installs missing patches.
Defines a filter used in Patch Manager APIs.
", + "base": "Defines a filter used in Patch Manager APIs. Supported filter keys depend on the API operation that includes the filter. Patch Manager API operations that use PatchOrchestratorFilter include the following:
Filters used to scope down the returned patches.
", - "DescribeInstancePatchesRequest$Filters": "An array of structures. Each entry in the array is a structure containing a Key, Value combination. Valid values for Key are Classification | KBId | Severity | State.
Each element in the array is a structure containing a key-value pair.
Windows Server
Supported keys for Windows Server instance patches include the following:
PATCH_SET
Sample values: OS | APPLICATION
PRODUCT
Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus
PRODUCT_FAMILY
Sample values: Windows | Office
MSRC_SEVERITY
Sample values: ServicePacks | Important | Moderate
CLASSIFICATION
Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates
PATCH_ID
Sample values: KB123456 | KB4516046
Linux
When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the Command Line Interface (CLI), the following command fails:
aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615
However, the following command succeeds:
aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615
Supported keys for Linux instance patches include the following:
PRODUCT
Sample values: AmazonLinux2018.03 | AmazonLinux2.0
NAME
Sample values: kernel-headers | samba-python | php
SEVERITY
Sample values: Critical | Important | Medium | Low
EPOCH
Sample values: 0 | 1
VERSION
Sample values: 78.6.1 | 4.10.16
RELEASE
Sample values: 9.56.amzn1 | 1.amzn2
ARCH
Sample values: i686 | x86_64
REPOSITORY
Sample values: Core | Updates
ADVISORY_ID
Sample values: ALAS-2018-1058 | ALAS2-2021-1594
CVE_ID
Sample values: CVE-2018-3615 | CVE-2020-1472
BUGZILLA_ID
Sample values: 1463241
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribeInstancePatchesinclude the following:
Classification
Sample values: Security | SecurityUpdates
KBId
Sample values: KB4480056 | java-1.7.0-openjdk.x86_64
Severity
Sample values: Important | Medium | Low
State
Sample values: Installed | InstalledOther | InstalledPendingReboot
Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.
", - "DescribePatchBaselinesRequest$Filters": "Each element in the array is a structure containing:
Key: (string, \"NAME_PREFIX\" or \"OWNER\")
Value: (array of strings, exactly 1 entry, between 1 and 255 characters)
", - "DescribePatchGroupsRequest$Filters": "One or more filters. Use a filter to return a more specific list of results.
For DescribePatchGroups,valid filter keys include the following:
NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.
OPERATING_SYSTEM: The supported operating system type to return results for. For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline.
Examples:
--filters Key=NAME_PREFIX,Values=MyPatchGroup*
--filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribePatchBaselines include the following:
NAME_PREFIX
Sample values: AWS- | My-
OWNER
Sample values: AWS | Self
OPERATING_SYSTEM
Sample values: AMAZON_LINUX | SUSE | WINDOWS
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribePatchGroups include the following:
NAME_PREFIX
Sample values: AWS- | My-.
OPERATING_SYSTEM
Sample values: AMAZON_LINUX | SUSE | WINDOWS
The number of instances with patches installed that are specified as other than \"Critical\" or \"Security\" but are not compliant with the patch baseline. The status of these instances is NON_COMPLIANT.
" + "InstancePatchState$OtherNonCompliantCount": "The number of instances with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these instances is NON_COMPLIANT.
The number of instances where patches that are specified as \"Security\" in a patch advisory are not installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
The number of instances where patches that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
Indicates whether to list patches for the Windows operating system or for Microsoft applications. Not applicable for the Linux or macOS operating systems.
" + "DescribePatchPropertiesRequest$PatchSet": "Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.
" } }, "PatchSeverity": { "base": null, "refs": { "Patch$Severity": "The severity level of the patch. For example, CRITICAL or MODERATE.
The severity of the patch (for example, Critical, Important, Moderate).
" + "PatchComplianceData$Severity": "The severity of the patchsuch as Critical, Important, and Moderate.
The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Not supported on Debian Server or Ubuntu Server.
Enter dates in the format YYYY-MM-DD. For example, 2020-12-31.
The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Not supported on Debian Server or Ubuntu Server.
Enter dates in the format YYYY-MM-DD. For example, 2021-12-31.
The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.
The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
The list of OS platforms compatible with this Systems Manager document.
", + "DocumentDescription$PlatformTypes": "The list of OS platforms compatible with this SSM document.
", "DocumentIdentifier$PlatformTypes": "The operating system platform.
" } }, @@ -6373,9 +6373,9 @@ } }, "ProgressCounters": { - "base": "An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
", + "base": "An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
", "refs": { - "AutomationExecution$ProgressCounters": "An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
" + "AutomationExecution$ProgressCounters": "An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
" } }, "PutComplianceItemsRequest": { @@ -6417,7 +6417,7 @@ "RebootOption": { "base": null, "refs": { - "InstancePatchState$RebootOption": "Indicates the reboot option specified in the patch baseline.
Reboot options apply to Install operations only. Reboots are not attempted for Patch Manager Scan operations.
RebootIfNeeded: Patch Manager tries to reboot the instance if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.
NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.
Indicates the reboot option specified in the patch baseline.
Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.
RebootIfNeeded: Patch Manager tries to reboot the instance if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.
NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.
The AWS Regions targeted by the current Automation execution.
" + "TargetLocation$Regions": "The Regions targeted by the current Automation execution.
" } }, "RegisterDefaultPatchBaselineRequest": { @@ -6476,7 +6476,7 @@ "base": null, "refs": { "Activation$RegistrationLimit": "The maximum number of managed instances that can be registered using this activation.
", - "CreateActivationRequest$RegistrationLimit": "Specify the maximum number of managed instances you want to register. The default value is 1 instance.
" + "CreateActivationRequest$RegistrationLimit": "Specify the maximum number of managed instances you want to register. The default value is 1.
The request body of the ResetServiceSetting API action.
", + "base": "The request body of the ResetServiceSetting API operation.
", "refs": { } }, "ResetServiceSettingResult": { - "base": "The result body of the ResetServiceSetting API action.
", + "base": "The result body of the ResetServiceSetting API operation.
", "refs": { } }, @@ -6569,9 +6569,9 @@ } }, "ResourceDataSyncAwsOrganizationsSource": { - "base": "Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations or, if an AWS Organization is not present, from multiple AWS Regions.
", + "base": "Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from Organizations or, if an Amazon Web Services organization isn't present, from multiple Regions.
Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations.
", + "ResourceDataSyncSource$AwsOrganizationsSource": "Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from Organizations.
The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.
Synchronize Systems Manager Inventory data from multiple AWS accounts defined in AWS Organizations to a centralized S3 bucket. Data is synchronized to individual key prefixes in the central bucket. Each key prefix represents a different AWS account ID.
", + "base": "Synchronize Amazon Web Services Systems Manager Inventory data from multiple accounts defined in Organizations to a centralized Amazon S3 bucket. Data is synchronized to individual key prefixes in the central bucket. Each key prefix represents a different account ID.
", "refs": { "ResourceDataSyncS3Destination$DestinationDataSharing": "Enables destination data sharing. By default, this field is null.
When you create a resource data sync, if you choose one of the AWS Organizations options, then Systems Manager automatically enables all OpsData sources in the selected AWS Regions for all AWS accounts in your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the AWS Systems Manager User Guide.
", - "ResourceDataSyncSourceWithState$EnableAllOpsDataSources": "When you create a resource data sync, if you choose one of the AWS Organizations options, then Systems Manager automatically enables all OpsData sources in the selected AWS Regions for all AWS accounts in your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the AWS Systems Manager User Guide.
" + "ResourceDataSyncSource$EnableAllOpsDataSources": "When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Regions for all accounts in your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.
", + "ResourceDataSyncSourceWithState$EnableAllOpsDataSources": "When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Regions for all accounts in your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.
" } }, "ResourceDataSyncIncludeFutureRegions": { "base": null, "refs": { - "ResourceDataSyncSource$IncludeFutureRegions": "Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
", - "ResourceDataSyncSourceWithState$IncludeFutureRegions": "Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
" + "ResourceDataSyncSource$IncludeFutureRegions": "Whether to automatically synchronize and aggregate data from new Regions when those Regions come online.
", + "ResourceDataSyncSourceWithState$IncludeFutureRegions": "Whether to automatically synchronize and aggregate data from new Regions when those Regions come online.
" } }, "ResourceDataSyncInvalidConfigurationException": { @@ -6623,7 +6623,7 @@ } }, "ResourceDataSyncItem": { - "base": "Information about a Resource Data Sync configuration, including its current status and last successful sync.
", + "base": "Information about a resource data sync configuration, including its current status and last successful sync.
", "refs": { "ResourceDataSyncItemList$member": null } @@ -6631,7 +6631,7 @@ "ResourceDataSyncItemList": { "base": null, "refs": { - "ListResourceDataSyncResult$ResourceDataSyncItems": "A list of your current Resource Data Sync configurations and their statuses.
" + "ListResourceDataSyncResult$ResourceDataSyncItems": "A list of your current resource data sync configurations and their statuses.
" } }, "ResourceDataSyncLastModifiedTime": { @@ -6647,24 +6647,24 @@ "DeleteResourceDataSyncRequest$SyncName": "The name of the configuration to delete.
", "GetOpsSummaryRequest$SyncName": "Specify the name of a resource data sync to get.
", "ResourceDataSyncAlreadyExistsException$SyncName": null, - "ResourceDataSyncItem$SyncName": "The name of the Resource Data Sync.
", + "ResourceDataSyncItem$SyncName": "The name of the resource data sync.
", "ResourceDataSyncNotFoundException$SyncName": null, "UpdateResourceDataSyncRequest$SyncName": "The name of the resource data sync you want to update.
" } }, "ResourceDataSyncNotFoundException": { - "base": "The specified sync name was not found.
", + "base": "The specified sync name wasn't found.
", "refs": { } }, "ResourceDataSyncOrganizationSourceType": { "base": null, "refs": { - "ResourceDataSyncAwsOrganizationsSource$OrganizationSourceType": "If an AWS Organization is present, this is either OrganizationalUnits or EntireOrganization. For OrganizationalUnits, the data is aggregated from a set of organization units. For EntireOrganization, the data is aggregated from the entire AWS Organization.
If an Amazon Web Services organization is present, this is either OrganizationalUnits or EntireOrganization. For OrganizationalUnits, the data is aggregated from a set of organization units. For EntireOrganization, the data is aggregated from the entire Amazon Web Services organization.
The AWS Organizations organizational unit data source for the sync.
", + "base": "The Organizations organizational unit data source for the sync.
", "refs": { "ResourceDataSyncOrganizationalUnitList$member": null } @@ -6672,13 +6672,13 @@ "ResourceDataSyncOrganizationalUnitId": { "base": null, "refs": { - "ResourceDataSyncOrganizationalUnit$OrganizationalUnitId": "The AWS Organization unit ID data source for the sync.
" + "ResourceDataSyncOrganizationalUnit$OrganizationalUnitId": "The Organizations unit ID data source for the sync.
" } }, "ResourceDataSyncOrganizationalUnitList": { "base": null, "refs": { - "ResourceDataSyncAwsOrganizationsSource$OrganizationalUnits": "The AWS Organizations organization units included in the sync.
" + "ResourceDataSyncAwsOrganizationsSource$OrganizationalUnits": "The Organizations organization units included in the sync.
" } }, "ResourceDataSyncS3BucketName": { @@ -6688,7 +6688,7 @@ } }, "ResourceDataSyncS3Destination": { - "base": "Information about the target S3 bucket for the Resource Data Sync.
", + "base": "Information about the target S3 bucket for the resource data sync.
", "refs": { "CreateResourceDataSyncRequest$S3Destination": "Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.
Configuration information for the target S3 bucket.
" @@ -6709,7 +6709,7 @@ "ResourceDataSyncS3Region": { "base": null, "refs": { - "ResourceDataSyncS3Destination$Region": "The AWS Region with the S3 bucket targeted by the Resource Data Sync.
" + "ResourceDataSyncS3Destination$Region": "The Region with the S3 bucket targeted by the resource data sync.
" } }, "ResourceDataSyncSource": { @@ -6728,19 +6728,19 @@ "ResourceDataSyncSourceRegionList": { "base": null, "refs": { - "ResourceDataSyncSource$SourceRegions": "The SyncSource AWS Regions included in the resource data sync.
The SyncSource AWS Regions included in the resource data sync.
The SyncSource Regions included in the resource data sync.
The SyncSource Regions included in the resource data sync.
The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations) or SingleAccountMultiRegions.
The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations) or singleAccountMultiRegions.
The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or SingleAccountMultiRegions.
The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or singleAccountMultiRegions.
The data type name for including resource data sync state. There are four sync states:
OrganizationNotExists (Your organization doesn't exist)
NoPermissions (The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer.)
InvalidOrganizationalUnit (You specified or selected an invalid unit in the resource data sync configuration.)
TrustedAccessDisabled (You disabled Systems Manager access in the organization in AWS Organizations.)
The data type name for including resource data sync state. There are four sync states:
OrganizationNotExists (Your organization doesn't exist)
NoPermissions (The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Amazon Web Services Systems Manager Explorer.)
InvalidOrganizationalUnit (You specified or selected an invalid unit in the resource data sync configuration.)
TrustedAccessDisabled (You disabled Systems Manager access in the organization in Organizations.)
Information about the source where the data was synchronized.
" } @@ -6748,16 +6748,16 @@ "ResourceDataSyncState": { "base": null, "refs": { - "ResourceDataSyncSourceWithState$State": "The data type name for including resource data sync state. There are four sync states:
OrganizationNotExists: Your organization doesn't exist.
NoPermissions: The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer.
InvalidOrganizationalUnit: You specified or selected an invalid unit in the resource data sync configuration.
TrustedAccessDisabled: You disabled Systems Manager access in the organization in AWS Organizations.
The data type name for including resource data sync state. There are four sync states:
OrganizationNotExists: Your organization doesn't exist.
NoPermissions: The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer.
InvalidOrganizationalUnit: You specified or selected an invalid unit in the resource data sync configuration.
TrustedAccessDisabled: You disabled Systems Manager access in the organization in Organizations.
Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple AWS accounts and Regions, as listed in AWS Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.
Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple accounts and Regions, as listed in Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.
Specify the type of resource data sync to delete.
", - "ListResourceDataSyncRequest$SyncType": "View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from AWS Organizations or from multiple AWS Regions.
The type of resource data sync. If SyncType is SyncToDestination, then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions.
View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from Organizations or from multiple Regions.
The type of resource data sync. If SyncType is SyncToDestination, then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from Organizations or from multiple Regions.
The type of resource data sync. The supported SyncType is SyncFromSource.
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
ManagedInstance: mi-012345abcde
The ManagedInstance type for this API operation is only for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.
The resource ID for which you want to see a list of tags.
", - "RemoveTagsFromResourceRequest$ResourceId": "The ID of the resource from which you want to remove tags. For example:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
The ID of the resource from which you want to remove tags. For example:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
The ManagedInstance type for this API operation is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
", + "base": "Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
", "refs": { } }, @@ -6789,16 +6789,16 @@ "ResourceTypeForTagging": { "base": null, "refs": { - "AddTagsToResourceRequest$ResourceType": "Specifies the type of resource you are tagging.
The ManagedInstance type for this API action is for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
Specifies the type of resource you are tagging.
The ManagedInstance type for this API operation is for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.
Returns a list of tags for a specific resource type.
", - "RemoveTagsFromResourceRequest$ResourceType": "The type of resource from which you want to remove a tag.
The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
The type of resource from which you want to remove a tag.
The ManagedInstance type for this API operation is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.
A numeric response code generated after running the plugin.
", - "GetCommandInvocationResult$ResponseCode": "The error level response code for the plugin script. If the response code is -1, then the command has not started running on the instance, or it was not received by the instance.
The error level response code for the plugin script. If the response code is -1, then the command hasn't started running on the instance, or it wasn't received by the instance.
Information about an Automation runbook (Automation document) used in a runbook workflow in Change Manager.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Information about an Automation runbook used in a runbook workflow in Change Manager.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Information about the Automation runbooks (Automation documents) that are run as part of a runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Information about the Automation runbooks (Automation documents) that are run during a runbook workflow in Change Manager.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Information about the Automation runbooks that are run as part of a runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Information about the Automation runbooks that are run during a runbook workflow in Change Manager.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Information about the Automation runbooks that are run during the runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
", - "CommandPlugin$OutputS3BucketName": "The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
i-02573cafcfEXAMPLE is the instance ID;
awsrunShellScript is the name of the plugin.
", + "CommandPlugin$OutputS3BucketName": "The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
i-02573cafcfEXAMPLE is the instance ID;
awsrunShellScript is the name of the plugin.
The name of an S3 bucket where execution logs are stored .
", - "MaintenanceWindowRunCommandParameters$OutputS3BucketName": "The name of the S3 bucket.
", + "MaintenanceWindowRunCommandParameters$OutputS3BucketName": "The name of the Amazon Simple Storage Service (Amazon S3) bucket.
", "S3OutputLocation$OutputS3BucketName": "The name of the S3 bucket.
", "SendCommandRequest$OutputS3BucketName": "The name of the S3 bucket where command execution responses should be stored.
" } @@ -6882,7 +6882,7 @@ "base": null, "refs": { "Command$OutputS3KeyPrefix": "The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
", - "CommandPlugin$OutputS3KeyPrefix": "The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
i-02573cafcfEXAMPLE is the instance ID;
awsrunShellScript is the name of the plugin.
", + "CommandPlugin$OutputS3KeyPrefix": "The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
i-02573cafcfEXAMPLE is the instance ID;
awsrunShellScript is the name of the plugin.
(Optional) The S3 bucket subfolder.
", "MaintenanceWindowRunCommandParameters$OutputS3KeyPrefix": "The S3 bucket subfolder.
", "S3OutputLocation$OutputS3KeyPrefix": "The S3 bucket subfolder.
", @@ -6896,7 +6896,7 @@ } }, "S3OutputUrl": { - "base": "A URL for the S3 bucket where you want to store the results of this request.
", + "base": "A URL for the Amazon Web Services Systems Manager (Systems Manager) bucket where you want to store the results of this request.
", "refs": { "InstanceAssociationOutputUrl$S3OutputUrl": "The URL of S3 bucket where you want to store the results of this request.
" } @@ -6905,9 +6905,9 @@ "base": null, "refs": { "Command$OutputS3Region": "(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
", - "CommandPlugin$OutputS3Region": "(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the S3 bucket region.
", + "CommandPlugin$OutputS3Region": "(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.
", "LoggingInfo$S3Region": "The Region where the S3 bucket is located.
", - "S3OutputLocation$OutputS3Region": "(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
", + "S3OutputLocation$OutputS3Region": "(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the Region of the S3 bucket.
", "SendCommandRequest$OutputS3Region": "(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
" } }, @@ -6957,23 +6957,23 @@ "ServiceRole": { "base": null, "refs": { - "Command$ServiceRole": "The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
", - "CommandInvocation$ServiceRole": "The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.
", + "Command$ServiceRole": "The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
", + "CommandInvocation$ServiceRole": "The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per instance basis.
", "GetMaintenanceWindowExecutionTaskResult$ServiceRole": "The role that was assumed when running the task.
", - "GetMaintenanceWindowTaskResult$ServiceRoleArn": "The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
", - "MaintenanceWindowRunCommandParameters$ServiceRoleArn": "The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
", - "MaintenanceWindowTask$ServiceRoleArn": "The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
", - "RegisterTaskWithMaintenanceWindowRequest$ServiceRoleArn": "The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
For more information, see the following topics in the in the AWS Systems Manager User Guide:
", - "SendCommandRequest$ServiceRoleArn": "The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
", - "UpdateMaintenanceWindowTaskRequest$ServiceRoleArn": "The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
For more information, see the following topics in the in the AWS Systems Manager User Guide:
", - "UpdateMaintenanceWindowTaskResult$ServiceRoleArn": "The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
" + "GetMaintenanceWindowTaskResult$ServiceRoleArn": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
", + "MaintenanceWindowRunCommandParameters$ServiceRoleArn": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
", + "MaintenanceWindowTask$ServiceRoleArn": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
", + "RegisterTaskWithMaintenanceWindowRequest$ServiceRoleArn": "The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:
", + "SendCommandRequest$ServiceRoleArn": "The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
", + "UpdateMaintenanceWindowTaskRequest$ServiceRoleArn": "The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:
", + "UpdateMaintenanceWindowTaskResult$ServiceRoleArn": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
" } }, "ServiceSetting": { - "base": "The service setting data structure.
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.
The service setting data structure.
ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.
The query result of the current service setting.
", - "ResetServiceSettingResult$ServiceSetting": "The current, effective service setting after calling the ResetServiceSetting API action.
" + "ResetServiceSettingResult$ServiceSetting": "The current, effective service setting after calling the ResetServiceSetting API operation.
" } }, "ServiceSettingId": { @@ -6986,7 +6986,7 @@ } }, "ServiceSettingNotFound": { - "base": "The specified service setting was not found. Either the service name or the setting has not been provisioned by the AWS service team.
", + "base": "The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.
", "refs": { } }, @@ -6994,7 +6994,7 @@ "base": null, "refs": { "ServiceSetting$SettingValue": "The value of the service setting.
", - "UpdateServiceSettingRequest$SettingValue": "The new value to specify for the service setting. For the /ssm/parameter-store/default-parameter-tier setting ID, the setting value can be one of the following.
Standard
Advanced
Intelligent-Tiering
For the /ssm/parameter-store/high-throughput-enabled, and /ssm/managed-instance/activation-tier setting IDs, the setting value can be true or false.
For the /ssm/automation/customer-script-log-destination setting ID, the setting value can be CloudWatch.
For the /ssm/automation/customer-script-log-group-name setting ID, the setting value can be the name of a CloudWatch Logs log group.
For the /ssm/documents/console/public-sharing-permission setting ID, the setting value can be Enable or Disable.
The new value to specify for the service setting. For the /ssm/parameter-store/default-parameter-tier setting ID, the setting value can be one of the following.
Standard
Advanced
Intelligent-Tiering
For the /ssm/parameter-store/high-throughput-enabled, and /ssm/managed-instance/activation-tier setting IDs, the setting value can be true or false.
For the /ssm/automation/customer-script-log-destination setting ID, the setting value can be CloudWatch.
For the /ssm/automation/customer-script-log-group-name setting ID, the setting value can be the name of an Amazon CloudWatch Logs log group.
For the /ssm/documents/console/public-sharing-permission setting ID, the setting value can be Enable or Disable.
The filter value. Valid values for each filter key are as follows:
InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
Target: Specify an instance to which session connections have been made.
Owner: Specify an AWS user account to see a list of sessions started by that user.
Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:
Connected
Connecting
Disconnected
Terminated
Terminating
Failed
SessionId: Specify a session ID to return details about the session.
The filter value. Valid values for each filter key are as follows:
InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
Target: Specify an instance to which session connections have been made.
Owner: Specify an Amazon Web Services user account to see a list of sessions started by that user.
Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:
Connected
Connecting
Disconnected
Terminated
Terminating
Failed
SessionId: Specify a session ID to return details about the session.
The ID of the AWS user account that started the session.
" + "Session$Owner": "The ID of the Amazon Web Services user account that started the session.
" } }, "SessionState": { @@ -7136,7 +7136,7 @@ "base": "The document version shared with other accounts. You can share Latest, Default or All versions.
The version of the current document shared with the account.
", - "ModifyDocumentPermissionRequest$SharedDocumentVersion": "(Optional) The version of the document to share. If it's not specified, the system choose the Default version to share.
(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.
A pre-signed Amazon S3 URL that can be used to download the patch snapshot.
" + "GetDeployablePatchSnapshotForInstanceResult$SnapshotDownloadUrl": "A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.
" } }, "SnapshotId": { "base": null, "refs": { - "GetDeployablePatchSnapshotForInstanceRequest$SnapshotId": "The user-defined snapshot ID.
", + "GetDeployablePatchSnapshotForInstanceRequest$SnapshotId": "The snapshot ID provided by the user when running AWS-RunPatchBaseline.
The user-defined snapshot ID.
", "InstancePatchState$SnapshotId": "The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
" } @@ -7162,13 +7162,13 @@ "StandardErrorContent": { "base": null, "refs": { - "GetCommandInvocationResult$StandardErrorContent": "The first 8,000 characters written by the plugin to stderr. If the command has not finished running, then this string is empty.
The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
The first 24,000 characters written by the plugin to stdout. If the command has not finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.
The first 24,000 characters written by the plugin to stdout. If the command hasn't finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.
A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command has not been sent to any instances.
In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.
Success: The command successfully ran on all invocations. This is a terminal state.
Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.
A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command has not been sent to the instance.
In Progress: The command has been sent to the instance but has not reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command has not been sent to the instance.
In Progress: The command has been sent to the instance but has not reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command has not been sent to the instance.
In Progress: The command has been sent to the instance but has not reached a terminal state.
Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, because the instance was stopped, or for similar reasons. The system will try to send the command again.
Success: The command or plugin ran successfully. This is a terminal state.
Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: The command started to run on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't run successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any instances.
In Progress: The command has been sent to at least one instance but hasn't reached a final state on all instances.
Success: The command successfully ran on all invocations. This is a terminal state.
Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
Incomplete: The command was attempted on all instances and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.
A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to the instance.
In Progress: The command has been sent to the instance but hasn't reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the instance, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to the instance.
In Progress: The command has been sent to the instance but hasn't reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the instance, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to the instance.
In Progress: The command has been sent to the instance but hasn't reached a terminal state.
Delayed: The system attempted to send the command to the target, but the target wasn't available. The instance might not be available because of network issues, because the instance was stopped, or for similar reasons. The system will try to send the command again.
Success: The command or plugin ran successfully. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: The command started to run on the instance, but the execution wasn't complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't run successfully on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.
", + "AutomationExecution$StepExecutions": "A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.
", "DescribeAutomationStepExecutionsResult$StepExecutions": "A list of details about the current state of all steps that make up an execution.
" } }, @@ -7316,8 +7316,8 @@ "StreamUrl": { "base": null, "refs": { - "ResumeSessionResponse$StreamUrl": "A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).
region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the AWS General Reference.
session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the AWS General Reference.
session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).
region represents the Region identifier for an Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.
session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
region represents the Region identifier for an Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.
session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
The ID of an OpsItem that is created to represent a Change Manager change request.
", "AutomationExecution$AssociationId": "The ID of a State Manager association used in the Automation operation.
", "AutomationExecutionLimitExceededException$Message": null, - "AutomationExecutionMetadata$ExecutedBy": "The IAM role ARN of the user who ran the Automation.
", + "AutomationExecutionMetadata$ExecutedBy": "The IAM role ARN of the user who ran the automation.
", "AutomationExecutionMetadata$LogFile": "An S3 bucket where execution information is stored.
", "AutomationExecutionMetadata$CurrentStepName": "The name of the step that is currently running.
", "AutomationExecutionMetadata$CurrentAction": "The action of the step that is currently running.
", - "AutomationExecutionMetadata$FailureMessage": "The list of execution outputs as defined in the Automation document.
", - "AutomationExecutionMetadata$Target": "The list of execution outputs as defined in the Automation document.
", + "AutomationExecutionMetadata$FailureMessage": "The list of execution outputs as defined in the Automation runbook.
", + "AutomationExecutionMetadata$Target": "The list of execution outputs as defined in the Automation runbook.
", "AutomationExecutionMetadata$OpsItemId": "The ID of an OpsItem that is created to represent a Change Manager change request.
", "AutomationExecutionMetadata$AssociationId": "The ID of a State Manager association used in the Automation operation.
", "AutomationExecutionNotFoundException$Message": null, @@ -7363,18 +7363,18 @@ "FailureDetails$FailureStage": "The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.
", "FailureDetails$FailureType": "The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.
", "FeatureNotAvailableException$Message": null, - "HierarchyLevelLimitExceededException$message": "A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the AWS Systems Manager User Guide.
", - "HierarchyTypeMismatchException$message": "Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.
A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the Amazon Web Services Systems Manager User Guide.
", + "HierarchyTypeMismatchException$message": "Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.
The name of the operating system platform running on your instance.
", "InstanceInformation$PlatformVersion": "The version of the OS platform running on your instance.
", - "InstanceInformation$Name": "The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances action. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.
The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.
The request does not meet the regular expression requirement.
", + "InvalidAllowedPatternException$message": "The request doesn't meet the regular expression requirement.
", "InvalidAssociation$Message": null, "InvalidAssociationVersion$Message": null, "InvalidAutomationExecutionParametersException$Message": null, @@ -7382,14 +7382,14 @@ "InvalidAutomationStatusUpdateException$Message": null, "InvalidDeleteInventoryParametersException$Message": null, "InvalidDeletionIdException$Message": null, - "InvalidDocument$Message": "The document does not exist or the document is not available to the user. This exception can be issued by CreateAssociation, CreateAssociationBatch, DeleteAssociation, DeleteDocument, DescribeAssociation, DescribeDocument, GetDocument, SendCommand, or UpdateAssociationStatus.
", + "InvalidDocument$Message": "The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations.
", "InvalidDocumentContent$Message": "A description of the validation error.
", "InvalidDocumentOperation$Message": null, "InvalidDocumentSchemaVersion$Message": null, "InvalidDocumentType$Message": null, "InvalidDocumentVersion$Message": null, "InvalidFilter$Message": null, - "InvalidFilterOption$message": "The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
", + "InvalidFilterOption$message": "The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
", "InvalidFilterValue$Message": null, "InvalidInstanceId$Message": null, "InvalidInstanceInformationFilterValue$message": null, @@ -7420,8 +7420,8 @@ "MaxDocumentSizeExceeded$Message": null, "NormalStringMap$key": null, "NormalStringMap$value": null, - "OpsItem$CreatedBy": "The ARN of the AWS account that created the OpsItem.
", - "OpsItem$LastModifiedBy": "The ARN of the AWS account that last updated the OpsItem.
", + "OpsItem$CreatedBy": "The ARN of the account that created the OpsItem.
", + "OpsItem$LastModifiedBy": "The ARN of the account that last updated the OpsItem.
", "OpsItem$Version": "The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
", "OpsItemAlreadyExistsException$Message": null, "OpsItemAlreadyExistsException$OpsItemId": null, @@ -7435,7 +7435,7 @@ "OpsItemLimitExceededException$LimitType": null, "OpsItemLimitExceededException$Message": null, "OpsItemNotFoundException$Message": null, - "OpsItemNotification$Arn": "The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
", + "OpsItemNotification$Arn": "The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
", "OpsItemOpsDataKeysList$member": null, "OpsItemParameterNamesList$member": null, "OpsItemRelatedItemAlreadyExistsException$Message": null, @@ -7449,18 +7449,18 @@ "OpsMetadataLimitExceededException$message": null, "OpsMetadataNotFoundException$message": null, "OpsMetadataTooManyUpdatesException$message": null, - "Parameter$SourceResult": "Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.
", + "Parameter$SourceResult": "Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.
The Amazon Resource Name (ARN) of the parameter.
", "ParameterAlreadyExists$message": null, - "ParameterHistory$LastModifiedUser": "Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
", + "ParameterHistory$LastModifiedUser": "Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.
", "ParameterInlinePolicy$PolicyText": "The JSON text of the policy.
", - "ParameterInlinePolicy$PolicyType": "The type of policy. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
", - "ParameterInlinePolicy$PolicyStatus": "The status of the policy. Policies report the following statuses: Pending (the policy has not been enforced or applied yet), Finished (the policy was applied), Failed (the policy was not applied), or InProgress (the policy is being applied now).
", + "ParameterInlinePolicy$PolicyType": "The type of policy. Parameter Store, a capablility of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
", + "ParameterInlinePolicy$PolicyStatus": "The status of the policy. Policies report the following statuses: Pending (the policy hasn't been enforced or applied yet), Finished (the policy was applied), Failed (the policy wasn't applied), or InProgress (the policy is being applied now).
", "ParameterLimitExceeded$message": null, "ParameterMaxVersionLimitExceeded$message": null, - "ParameterMetadata$LastModifiedUser": "Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
", + "ParameterMetadata$LastModifiedUser": "Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.
", "ParameterNotFound$message": null, - "ParameterPatternMismatchException$message": "The parameter name is not valid.
", + "ParameterPatternMismatchException$message": "The parameter name isn't valid.
", "ParameterVersionLabelLimitExceeded$message": null, "ParameterVersionNotFound$message": null, "PoliciesLimitExceededException$message": null, @@ -7473,10 +7473,10 @@ "ResourceLimitExceededException$Message": null, "ServiceSetting$LastModifiedUser": "The ARN of the last modified user. This field is populated only if the setting value was overwritten.
", "ServiceSetting$ARN": "The ARN of the service setting.
", - "ServiceSetting$Status": "The status of the service setting. The value can be Default, Customized or PendingUpdate.
Default: The current setting uses a default value provisioned by the AWS service team.
Customized: The current setting use a custom value specified by the customer.
PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.
The status of the service setting. The value can be Default, Customized or PendingUpdate.
Default: The current setting uses a default value provisioned by the Amazon Web Services service team.
Customized: The current setting use a custom value specified by the customer.
PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.
The name of this execution step.
", - "StepExecution$OnFailure": "The action to take if the step fails. The default value is Abort.
", + "StepExecution$OnFailure": "The action to take if the step fails. The default value is Abort.
The response code returned by the execution of the step.
", "StepExecution$Response": "A message associated with the response code for an execution.
", "StepExecution$FailureMessage": "If a step failed, this message explains why the execution failed.
", @@ -7500,9 +7500,9 @@ "StringDateTime": { "base": null, "refs": { - "GetCommandInvocationResult$ExecutionStartDateTime": "The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter.
aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z
If the plugin has not started to run, the string is empty.
", + "GetCommandInvocationResult$ExecutionStartDateTime": "The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedBefore filter.
aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
", "GetCommandInvocationResult$ExecutionElapsedTime": "Duration since ExecutionStartDateTime.
The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter.
aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z
If the plugin has not started to run, the string is empty.
" + "GetCommandInvocationResult$ExecutionEndDateTime": "The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedAfter filter.
aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
" } }, "StringList": { @@ -7517,7 +7517,7 @@ } }, "Tag": { - "base": "Metadata that you assign to your AWS resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Systems Manager, you can apply tags to documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines.
", + "base": "Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed instances, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.
", "refs": { "TagList$member": null } @@ -7533,19 +7533,19 @@ "base": null, "refs": { "Activation$Tags": "Tags assigned to the activation.
", - "AddTagsToResourceRequest$Tags": "One or more tags. The value parameter is required.
Do not enter personally identifiable information in this field.
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.
You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with \"mi-\". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.
", - "CreateDocumentRequest$Tags": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource action.
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource action.
Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Tags use a key-value pair. For example:
Key=Department,Value=Finance
To add tags to an existing OpsItem, use the AddTagsToResource action.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key name/value pairs:
Key=PatchSeverity,Value=Critical
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource action.
One or more tags. The value parameter is required.
Don't enter personally identifiable information in this field.
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.
You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with \"mi-\". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.
", + "CreateDocumentRequest$Tags": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource operation.
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource operation.
Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
Tags use a key-value pair. For example:
Key=Department,Value=Finance
To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target Region. In this case, you could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs:
Key=PatchSeverity,Value=Critical
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource operation.
The tags, or metadata, that have been applied to the document.
", "DocumentIdentifier$Tags": "The tags, or metadata, that have been applied to the document.
", "ListTagsForResourceResult$TagList": "A list of tags.
", - "PutParameterRequest$Tags": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:
Key=Resource,Value=S3bucket
Key=OS,Value=Windows
Key=ParameterType,Value=LicenseKey
To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key name/value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource action.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:
Key=Resource,Value=S3bucket
Key=OS,Value=Windows
Key=ParameterType,Value=LicenseKey
To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource operation.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Region. In this case, you could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2
An array of search criteria that targets instances using a Key,Value combination that you specify.
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
Supported formats include the following.
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
Key=tag-key,Values=my-tag-key-1,my-tag-key-2
Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=resource-group-name
Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Automation targets only: Key=ResourceGroup;Values=resource-group-name
For example:
Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
Key=tag-key,Values=Name,Instance-Type,CostCenter
Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup
This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
This example demonstrates how to target only EC2 instances and VPCs in your maintenance window.
Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
State Manager association targets only: Key=InstanceIds,Values=*
This example demonstrates how to target all managed instances in the AWS Region where the association was created.
For more information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
An array of search criteria that targets instances using a key-value pair that you specify.
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
Supported formats include the following.
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
Key=tag-key,Values=my-tag-key-1,my-tag-key-2
Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=resource-group-name
Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Automation targets only: Key=ResourceGroup;Values=resource-group-name
For example:
Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
Key=tag-key,Values=Name,Instance-Type,CostCenter
Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup
This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
State Manager association targets only: Key=InstanceIds,Values=*
This example demonstrates how to target all managed instances in the Region where the association was created.
For more information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.
The combination of AWS Regions and accounts targeted by the current Automation execution.
", + "base": "The combination of Regions and accounts targeted by the current Automation execution.
", "refs": { - "StepExecution$TargetLocation": "The combination of AWS Regions and accounts targeted by the current Automation execution.
", + "StepExecution$TargetLocation": "The combination of Regions and accounts targeted by the current Automation execution.
", "TargetLocations$member": null } }, "TargetLocations": { "base": null, "refs": { - "AssociationDescription$TargetLocations": "The combination of AWS Regions and AWS accounts where you want to run the association.
", - "AssociationVersionInfo$TargetLocations": "The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created.
", - "AutomationExecution$TargetLocations": "The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
", + "AssociationDescription$TargetLocations": "The combination of Regions and accounts where you want to run the association.
", + "AssociationVersionInfo$TargetLocations": "The combination of Regions and accounts where you wanted to run the association when this association version was created.
", + "AutomationExecution$TargetLocations": "The combination of Regions and/or accounts where you want to run the Automation.
", "CreateAssociationBatchRequestEntry$TargetLocations": "Use this action to create an association in multiple Regions and multiple accounts.
", - "CreateAssociationRequest$TargetLocations": "A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
", - "Runbook$TargetLocations": "Information about the AWS Regions and accounts targeted by the current Runbook operation.
", - "StartAutomationExecutionRequest$TargetLocations": "A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple AWS Regions and accounts in the AWS Systems Manager User Guide.
", - "UpdateAssociationRequest$TargetLocations": "A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
" + "CreateAssociationRequest$TargetLocations": "A location is a combination of Regions and accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
", + "Runbook$TargetLocations": "Information about the Regions and accounts targeted by the current Runbook operation.
", + "StartAutomationExecutionRequest$TargetLocations": "A location is a combination of Regions and/or accounts where you want to run the automation. Use this operation to start an automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.
", + "UpdateAssociationRequest$TargetLocations": "A location is a combination of Regions and accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
" } }, "TargetMap": { @@ -7626,11 +7626,11 @@ "refs": { "AutomationExecution$TargetMaps": "The specified key-value mapping of document parameters to target resources.
", "AutomationExecutionMetadata$TargetMaps": "The specified key-value mapping of document parameters to target resources.
", - "StartAutomationExecutionRequest$TargetMaps": "A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.
" + "StartAutomationExecutionRequest$TargetMaps": "A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
" } }, "TargetNotConnected": { - "base": "The specified target instance for the session is not fully configured for use with Session Manager. For more information, see Getting started with Session Manager in the AWS Systems Manager User Guide. This error is also returned if you attempt to start a session on an instance that is located in a different account or Region
", + "base": "The specified target instance for the session isn't fully configured for use with Session Manager. For more information, see Getting started with Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you attempt to start a session on an instance that is located in a different account or Region
", "refs": { } }, @@ -7643,9 +7643,9 @@ "TargetType": { "base": null, "refs": { - "CreateDocumentRequest$TargetType": "Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide.
", - "DocumentDescription$TargetType": "The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide.
", - "DocumentIdentifier$TargetType": "The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide.
", + "CreateDocumentRequest$TargetType": "Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
Specify a new target type for the document.
" } }, @@ -7658,7 +7658,7 @@ "TargetValues": { "base": null, "refs": { - "Target$Values": "User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.
Depending on the type of Target, the maximum number of values for a Key might be lower than the global maximum of 50.
User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.
Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
" } }, "Targets": { @@ -7668,25 +7668,25 @@ "AssociationDescription$Targets": "The instances targeted by the request.
", "AssociationVersionInfo$Targets": "The targets specified for the association when the association version was created.
", "AutomationExecution$Targets": "The specified targets.
", - "AutomationExecutionMetadata$Targets": "The targets defined by the user when starting the Automation.
", + "AutomationExecutionMetadata$Targets": "The targets defined by the user when starting the automation.
", "Command$Targets": "An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
", "CreateAssociationBatchRequestEntry$Targets": "The instances targeted by the request.
", - "CreateAssociationRequest$Targets": "The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.
", - "DescribeMaintenanceWindowScheduleRequest$Targets": "The instance ID or key/value pair to retrieve information about.
", - "DescribeMaintenanceWindowsForTargetRequest$Targets": "The instance ID or key/value pair to retrieve information about.
", + "CreateAssociationRequest$Targets": "The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.
", + "DescribeMaintenanceWindowScheduleRequest$Targets": "The instance ID or key-value pair to retrieve information about.
", + "DescribeMaintenanceWindowsForTargetRequest$Targets": "The instance ID or key-value pair to retrieve information about.
", "GetMaintenanceWindowTaskResult$Targets": "The targets where the task should run.
", "MaintenanceWindowTarget$Targets": "The targets, either instances or tags.
Specify instances using the following format:
Key=instanceids,Values=<instanceid1>,<instanceid2>
Tags are specified using the following format:
Key=<tag name>,Values=<tag value>.
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
", - "RegisterTargetWithMaintenanceWindowRequest$Targets": "The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.
If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.
You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.
Example 1: Specify instance IDs
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Example 2: Use tag key-pairs applied to instances
Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
Example 3: Use tag-keys applied to instances
Key=tag-key,Values=my-tag-key-1,my-tag-key-2
Example 4: Use resource group names
Key=resource-groups:Name,Values=resource-group-name
Example 5: Use filters for resource group types
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format
Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.
", - "RegisterTaskWithMaintenanceWindowRequest$Targets": "The targets (either instances or maintenance window targets).
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
Specify instances using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify maintenance window targets using the following format:
Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>
A key-value mapping to target resources that the Runbook operation performs tasks on. Required if you specify TargetParameterName.
An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.
To send a command to a smaller number of instances, you can use the InstanceIds option instead.
For more information about how to use targets, see Sending commands to a fleet in the AWS Systems Manager User Guide.
", + "MaintenanceWindowTask$Targets": "The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.
If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.
You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.
Example 1: Specify instance IDs
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Example 2: Use tag key-pairs applied to instances
Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
Example 3: Use tag-keys applied to instances
Key=tag-key,Values=my-tag-key-1,my-tag-key-2
Example 4: Use resource group names
Key=resource-groups:Name,Values=resource-group-name
Example 5: Use filters for resource group types
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format
Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.
", + "RegisterTaskWithMaintenanceWindowRequest$Targets": "The targets (either instances or maintenance window targets).
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
Specify instances using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify maintenance window targets using the following format:
Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.
An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.
To send a command to a smaller number of instances, you can use the InstanceIds option instead.
For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.
", "StartAutomationExecutionRequest$Targets": "A key-value mapping to target resources. Required if you specify TargetParameterName.
", "StepExecution$Targets": "The targets for the step execution.
", "UpdateAssociationRequest$Targets": "The targets of the association.
", "UpdateMaintenanceWindowTargetRequest$Targets": "The targets to add or replace.
", "UpdateMaintenanceWindowTargetResult$Targets": "The updated targets.
", - "UpdateMaintenanceWindowTaskRequest$Targets": "The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
The targets (either instances or tags) to modify. Instances are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using the format Key=tag_name,Values=tag_value.
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
The updated target values.
" } }, @@ -7704,8 +7704,8 @@ "base": null, "refs": { "Command$TimeoutSeconds": "The TimeoutSeconds value specified for a command.
If this time is reached and the command has not already started running, it doesn't run.
", - "SendCommandRequest$TimeoutSeconds": "If this time is reached and the command has not already started running, it will not run.
" + "MaintenanceWindowRunCommandParameters$TimeoutSeconds": "If this time is reached and the command hasn't already started running, it doesn't run.
", + "SendCommandRequest$TimeoutSeconds": "If this time is reached and the command hasn't already started running, it won't run.
" } }, "TokenValue": { @@ -7728,7 +7728,7 @@ "TotalCount": { "base": null, "refs": { - "InventoryDeletionSummary$TotalCount": "The total number of items to delete. This count does not change during the delete operation.
" + "InventoryDeletionSummary$TotalCount": "The total number of items to delete. This count doesn't change during the delete operation.
" } }, "TotalSizeLimitExceededException": { @@ -7740,9 +7740,9 @@ "base": null, "refs": { "DeleteInventoryRequest$ClientToken": "User-provided idempotency token.
", - "DeleteInventoryResult$DeletionId": "Every DeleteInventory action is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other actions.
Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory action.
The deletion ID returned by the DeleteInventory action.
Every DeleteInventory operation is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other operations.
Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory operation.
The deletion ID returned by the DeleteInventory operation.
The calendar entry contained in the specified Systems Manager document is not supported.
", + "base": "The calendar entry contained in the specified SSM document isn't supported.
", "refs": { } }, "UnsupportedFeatureRequiredException": { - "base": "Microsoft application patching is only available on EC2 instances and advanced instances. To patch Microsoft applications on on-premises servers and VMs, you must enable advanced instances. For more information, see Using the advanced-instances tier in the AWS Systems Manager User Guide.
", + "base": "Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see Enabling the advanced-instances tier in the Amazon Web Services Systems Manager User Guide.
", "refs": { } }, "UnsupportedInventoryItemContextException": { - "base": "The Context attribute that you specified for the InventoryItem is not allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem.
The Context attribute that you specified for the InventoryItem isn't allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem.
The operating systems you specified is not supported, or the operation is not supported for the operating system.
", + "base": "The operating systems you specified isn't supported, or the operation isn't supported for the operating system.
", "refs": { } }, "UnsupportedParameterType": { - "base": "The parameter type is not supported.
", + "base": "The parameter type isn't supported.
", "refs": { } }, "UnsupportedPlatformType": { - "base": "The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.
", + "base": "The document doesn't support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.
", "refs": { } }, @@ -7921,24 +7921,24 @@ } }, "UpdateServiceSettingRequest": { - "base": "The request body of the UpdateServiceSetting API action.
", + "base": "The request body of the UpdateServiceSetting API operation.
", "refs": { } }, "UpdateServiceSettingResult": { - "base": "The result body of the UpdateServiceSetting API action.
", + "base": "The result body of the UpdateServiceSetting API operation.
", "refs": { } }, "Url": { "base": null, "refs": { - "CommandInvocation$StandardOutputUrl": "The URL to the plugin's StdOut file in Amazon S3, if the S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
", - "CommandInvocation$StandardErrorUrl": "The URL to the plugin's StdErr file in Amazon S3, if the S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
", - "CommandPlugin$StandardOutputUrl": "The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command was not specified, then this string is empty.
", - "CommandPlugin$StandardErrorUrl": "The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.
", - "GetCommandInvocationResult$StandardOutputUrl": "The URL for the complete text written by the plugin to stdout in Amazon Simple Storage Service (Amazon S3). If an S3 bucket was not specified, then this string is empty.
The URL for the complete text written by the plugin to stderr. If the command has not finished running, then this string is empty.
The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command wasn't specified, then this string is empty.
", + "CommandPlugin$StandardErrorUrl": "The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.
", + "GetCommandInvocationResult$StandardOutputUrl": "The URL for the complete text written by the plugin to stdout in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.
The URL for the complete text written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
A URL for an S3 bucket where you want to store the results of this request.
" } }, diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index d1a8a031aaa..f27192c1bd0 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -787,6 +787,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, diff --git a/service/amplifybackend/api.go b/service/amplifybackend/api.go index 5cdd2a5c5f1..b6a35dc71e5 100644 --- a/service/amplifybackend/api.go +++ b/service/amplifybackend/api.go @@ -2432,7 +2432,7 @@ type BackendAPIResourceConfig struct { AdditionalAuthTypes []*BackendAPIAuthType `locationName:"additionalAuthTypes" type:"list"` // The API name used to interact with the data model, configured as a part of - // the amplify project. + // your Amplify project. ApiName *string `locationName:"apiName" type:"string"` // The conflict resolution strategy for your data stored in the data models. @@ -2496,16 +2496,68 @@ func (s *BackendAPIResourceConfig) SetTransformSchema(v string) *BackendAPIResou return s } +// Describes Apple social federation configurations for allowing your app users +// to sign in using OAuth. +type BackendAuthAppleProviderConfig struct { + _ struct{} `type:"structure"` + + // Describes the client_id (also called Services ID) that comes from Apple. + ClientId *string `locationName:"client_id" type:"string"` + + // Describes the key_id that comes from Apple. + KeyId *string `locationName:"key_id" type:"string"` + + // Describes the private_key that comes from Apple. + PrivateKey *string `locationName:"private_key" type:"string"` + + // Describes the team_id that comes from Apple. + TeamId *string `locationName:"team_id" type:"string"` +} + +// String returns the string representation +func (s BackendAuthAppleProviderConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BackendAuthAppleProviderConfig) GoString() string { + return s.String() +} + +// SetClientId sets the ClientId field's value. +func (s *BackendAuthAppleProviderConfig) SetClientId(v string) *BackendAuthAppleProviderConfig { + s.ClientId = &v + return s +} + +// SetKeyId sets the KeyId field's value. +func (s *BackendAuthAppleProviderConfig) SetKeyId(v string) *BackendAuthAppleProviderConfig { + s.KeyId = &v + return s +} + +// SetPrivateKey sets the PrivateKey field's value. +func (s *BackendAuthAppleProviderConfig) SetPrivateKey(v string) *BackendAuthAppleProviderConfig { + s.PrivateKey = &v + return s +} + +// SetTeamId sets the TeamId field's value. +func (s *BackendAuthAppleProviderConfig) SetTeamId(v string) *BackendAuthAppleProviderConfig { + s.TeamId = &v + return s +} + // Describes third-party social federation configurations for allowing your // app users to sign in using OAuth. type BackendAuthSocialProviderConfig struct { _ struct{} `type:"structure"` - // Describes the client_id which can be obtained from the third-party social + // Describes the client_id, which can be obtained from the third-party social // federation provider. ClientId *string `locationName:"client_id" type:"string"` - // Describes the client_secret which can be obtained from third-party social + // Describes the client_secret, which can be obtained from third-party social // federation providers. ClientSecret *string `locationName:"client_secret" type:"string"` } @@ -2954,7 +3006,7 @@ type CreateBackendAuthForgotPasswordConfig struct { _ struct{} `type:"structure"` // Describes which mode to use (either SMS or email) to deliver messages to - // app users that want to recover their password. + // app users who want to recover their password. // // DeliveryMethod is a required field DeliveryMethod *string `locationName:"deliveryMethod" type:"string" required:"true" enum:"DeliveryMethod"` @@ -3146,13 +3198,13 @@ func (s *CreateBackendAuthInput) SetResourceName(v string) *CreateBackendAuthInp return s } -// Describes whether multi-factor authentication policies should be applied -// for your Amazon Cognito user pool configured as a part of your Amplify project. +// Describes whether to apply multi-factor authentication policies for your +// Amazon Cognito user pool configured as a part of your Amplify project. type CreateBackendAuthMFAConfig struct { _ struct{} `type:"structure"` - // Describes whether MFA should be [ON, OFF, OPTIONAL] for authentication in - // your Amplify project. + // Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication + // in your Amplify project. // // MFAMode is a required field MFAMode *string `type:"string" required:"true" enum:"MFAMode"` @@ -3221,7 +3273,7 @@ type CreateBackendAuthOAuthConfig struct { // RedirectSignInURIs is a required field RedirectSignInURIs []*string `locationName:"redirectSignInURIs" type:"list" required:"true"` - // Redirect URLs used by OAuth when a user signs out of an Amplify app. + // Redirect URLs that OAuth uses when a user signs out of an Amplify app. // // RedirectSignOutURIs is a required field RedirectSignOutURIs []*string `locationName:"redirectSignOutURIs" type:"list" required:"true"` @@ -3510,8 +3562,8 @@ type CreateBackendAuthUserPoolConfig struct { // configured as a part of your Amplify project. ForgotPassword *CreateBackendAuthForgotPasswordConfig `locationName:"forgotPassword" type:"structure"` - // Describes whether multi-factor authentication policies should be applied - // for your Amazon Cognito user pool configured as a part of your Amplify project. + // Describes whether to apply multi-factor authentication policies for your + // Amazon Cognito user pool configured as a part of your Amplify project. Mfa *CreateBackendAuthMFAConfig `locationName:"mfa" type:"structure"` // Describes the OAuth policy and rules for your Amazon Cognito user pool, configured @@ -5968,6 +6020,10 @@ type SocialProviderSettings struct { // Describes third-party social federation configurations for allowing your // app users to sign in using OAuth. LoginWithAmazon *BackendAuthSocialProviderConfig `type:"structure"` + + // Describes Apple social federation configurations for allowing your app users + // to sign in using OAuth. + SignInWithApple *BackendAuthAppleProviderConfig `type:"structure"` } // String returns the string representation @@ -5998,6 +6054,12 @@ func (s *SocialProviderSettings) SetLoginWithAmazon(v *BackendAuthSocialProvider return s } +// SetSignInWithApple sets the SignInWithApple field's value. +func (s *SocialProviderSettings) SetSignInWithApple(v *BackendAuthAppleProviderConfig) *SocialProviderSettings { + s.SignInWithApple = v + return s +} + // An error that is returned when a limit of a specific type has been exceeded. type TooManyRequestsException struct { _ struct{} `type:"structure"` @@ -6244,7 +6306,7 @@ func (s *UpdateBackendAuthForgotPasswordConfig) SetSmsSettings(v *SmsSettings) * type UpdateBackendAuthIdentityPoolConfig struct { _ struct{} `type:"structure"` - // A boolean value which can be set to allow or disallow guest-level authorization + // A boolean value that can be set to allow or disallow guest-level authorization // into your Amplify app. UnauthenticatedLogin *bool `locationName:"unauthenticatedLogin" type:"boolean"` } @@ -6400,10 +6462,10 @@ type UpdateBackendAuthOAuthConfig struct { // your Amplify app. OAuthScopes []*string `locationName:"oAuthScopes" type:"list"` - // Redirect URLs used by OAuth when a user signs in to an Amplify app. + // Redirect URLs that OAuth uses when a user signs in to an Amplify app. RedirectSignInURIs []*string `locationName:"redirectSignInURIs" type:"list"` - // Redirect URLs used by OAuth when a user signs out of an Amplify app. + // Redirect URLs that OAuth uses when a user signs out of an Amplify app. RedirectSignOutURIs []*string `locationName:"redirectSignOutURIs" type:"list"` // Describes third-party social federation configurations for allowing your @@ -6645,8 +6707,8 @@ type UpdateBackendAuthUserPoolConfig struct { // as a part of your Amplify project. ForgotPassword *UpdateBackendAuthForgotPasswordConfig `locationName:"forgotPassword" type:"structure"` - // Describes whether multi-factor authentication policies should be applied - // for your Amazon Cognito user pool configured as a part of your Amplify project. + // Describes whether to apply multi-factor authentication policies for your + // Amazon Cognito user pool configured as a part of your Amplify project. Mfa *UpdateBackendAuthMFAConfig `locationName:"mfa" type:"structure"` // Describes the OAuth policy and rules for your Amazon Cognito user pool, configured diff --git a/service/directconnect/api.go b/service/directconnect/api.go index 36fd3e2ae95..66925c94d96 100644 --- a/service/directconnect/api.go +++ b/service/directconnect/api.go @@ -152,7 +152,7 @@ func (c *DirectConnect) AllocateConnectionOnInterconnectRequest(input *AllocateC // Allocates a VLAN number and a specified amount of bandwidth for use by a // hosted connection on the specified interconnect. // -// Intended for use by AWS Direct Connect Partners only. +// Intended for use by Direct Connect Partners only. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -243,11 +243,11 @@ func (c *DirectConnect) AllocateHostedConnectionRequest(input *AllocateHostedCon // // Allocates a VLAN number and a specified amount of capacity (bandwidth) for // use by a hosted connection on the specified interconnect or LAG of interconnects. -// AWS polices the hosted connection for the specified capacity and the AWS -// Direct Connect Partner must also police the hosted connection for the specified -// capacity. +// Amazon Web Services polices the hosted connection for the specified capacity +// and the Direct Connect Partner must also police the hosted connection for +// the specified capacity. // -// Intended for use by AWS Direct Connect Partners only. +// Intended for use by Direct Connect Partners only. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -335,7 +335,7 @@ func (c *DirectConnect) AllocatePrivateVirtualInterfaceRequest(input *AllocatePr // AllocatePrivateVirtualInterface API operation for AWS Direct Connect. // -// Provisions a private virtual interface to be owned by the specified AWS account. +// Provisions a private virtual interface to be owned by the specified account. // // Virtual interfaces created using this action must be confirmed by the owner // using ConfirmPrivateVirtualInterface. Until then, the virtual interface is @@ -427,10 +427,10 @@ func (c *DirectConnect) AllocatePublicVirtualInterfaceRequest(input *AllocatePub // AllocatePublicVirtualInterface API operation for AWS Direct Connect. // -// Provisions a public virtual interface to be owned by the specified AWS account. +// Provisions a public virtual interface to be owned by the specified account. // // The owner of a connection calls this function to provision a public virtual -// interface to be owned by the specified AWS account. +// interface to be owned by the specified account. // // Virtual interfaces created using this function must be confirmed by the owner // using ConfirmPublicVirtualInterface. Until this step has been completed, @@ -527,12 +527,12 @@ func (c *DirectConnect) AllocateTransitVirtualInterfaceRequest(input *AllocateTr // AllocateTransitVirtualInterface API operation for AWS Direct Connect. // -// Provisions a transit virtual interface to be owned by the specified AWS account. +// Provisions a transit virtual interface to be owned by the specified account. // Use this type of interface to connect a transit gateway to your Direct Connect // gateway. // // The owner of a connection provisions a transit virtual interface to be owned -// by the specified AWS account. +// by the specified account. // // After you create a transit virtual interface, it must be confirmed by the // owner using ConfirmTransitVirtualInterface. Until this step has been completed, @@ -627,12 +627,12 @@ func (c *DirectConnect) AssociateConnectionWithLagRequest(input *AssociateConnec // // Associates an existing connection with a link aggregation group (LAG). The // connection is interrupted and re-established as a member of the LAG (connectivity -// to AWS is interrupted). The connection must be hosted on the same AWS Direct -// Connect endpoint as the LAG, and its bandwidth must match the bandwidth for -// the LAG. You can re-associate a connection that's currently associated with -// a different LAG; however, if removing the connection would cause the original -// LAG to fall below its setting for minimum number of operational connections, -// the request fails. +// to Amazon Web Services is interrupted). The connection must be hosted on +// the same Direct Connect endpoint as the LAG, and its bandwidth must match +// the bandwidth for the LAG. You can re-associate a connection that's currently +// associated with a different LAG; however, if removing the connection would +// cause the original LAG to fall below its setting for minimum number of operational +// connections, the request fails. // // Any virtual interfaces that are directly associated with the connection are // automatically re-associated with the LAG. If the connection was originally @@ -727,9 +727,9 @@ func (c *DirectConnect) AssociateHostedConnectionRequest(input *AssociateHostedC // group (LAG) or interconnect. If the target interconnect or LAG has an existing // hosted connection with a conflicting VLAN number or IP address, the operation // fails. This action temporarily interrupts the hosted connection's connectivity -// to AWS as it is being migrated. +// to Amazon Web Services as it is being migrated. // -// Intended for use by AWS Direct Connect Partners only. +// Intended for use by Direct Connect Partners only. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -812,14 +812,14 @@ func (c *DirectConnect) AssociateMacSecKeyRequest(input *AssociateMacSecKeyInput // AssociateMacSecKey API operation for AWS Direct Connect. // // Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity -// Association Key (CAK) pair with an AWS Direct Connect dedicated connection. +// Association Key (CAK) pair with an Direct Connect dedicated connection. // // You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in // the request. // // For information about MAC Security (MACsec) key considerations, see MACsec // pre-shared CKN/CAK key considerations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-key-consideration) -// in the AWS Direct Connect User Guide. +// in the Direct Connect User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -902,10 +902,10 @@ func (c *DirectConnect) AssociateVirtualInterfaceRequest(input *AssociateVirtual // AssociateVirtualInterface API operation for AWS Direct Connect. // // Associates a virtual interface with a specified link aggregation group (LAG) -// or connection. Connectivity to AWS is temporarily interrupted as the virtual -// interface is being migrated. If the target connection or LAG has an associated -// virtual interface with a conflicting VLAN number or a conflicting IP address, -// the operation fails. +// or connection. Connectivity to Amazon Web Services is temporarily interrupted +// as the virtual interface is being migrated. If the target connection or LAG +// has an associated virtual interface with a conflicting VLAN number or a conflicting +// IP address, the operation fails. // // Virtual interfaces associated with a hosted connection cannot be associated // with a LAG; hosted connections must be migrated along with their virtual @@ -1082,7 +1082,7 @@ func (c *DirectConnect) ConfirmPrivateVirtualInterfaceRequest(input *ConfirmPriv // ConfirmPrivateVirtualInterface API operation for AWS Direct Connect. // -// Accepts ownership of a private virtual interface created by another AWS account. +// Accepts ownership of a private virtual interface created by another account. // // After the virtual interface owner makes this call, the virtual interface // is created and attached to the specified virtual private gateway or Direct @@ -1168,7 +1168,7 @@ func (c *DirectConnect) ConfirmPublicVirtualInterfaceRequest(input *ConfirmPubli // ConfirmPublicVirtualInterface API operation for AWS Direct Connect. // -// Accepts ownership of a public virtual interface created by another AWS account. +// Accepts ownership of a public virtual interface created by another account. // // After the virtual interface owner makes this call, the specified virtual // interface is created and made available to handle traffic. @@ -1253,7 +1253,7 @@ func (c *DirectConnect) ConfirmTransitVirtualInterfaceRequest(input *ConfirmTran // ConfirmTransitVirtualInterface API operation for AWS Direct Connect. // -// Accepts ownership of a transit virtual interface created by another AWS account. +// Accepts ownership of a transit virtual interface created by another account. // // After the owner of the transit virtual interface makes this call, the specified // transit virtual interface is created and made available to handle traffic. @@ -1341,7 +1341,8 @@ func (c *DirectConnect) CreateBGPPeerRequest(input *CreateBGPPeerInput) (req *re // Creates a BGP peer on the specified virtual interface. // // You must create a BGP peer for the corresponding address family (IPv4/IPv6) -// in order to access AWS resources that also use that address family. +// in order to access Amazon Web Services resources that also use that address +// family. // // If logical redundancy is not supported by the connection, interconnect, or // LAG, the BGP peer cannot be in the same address family as an existing BGP @@ -1434,18 +1435,18 @@ func (c *DirectConnect) CreateConnectionRequest(input *CreateConnectionInput) (r // CreateConnection API operation for AWS Direct Connect. // -// Creates a connection between a customer network and a specific AWS Direct -// Connect location. +// Creates a connection between a customer network and a specific Direct Connect +// location. // -// A connection links your internal network to an AWS Direct Connect location -// over a standard Ethernet fiber-optic cable. One end of the cable is connected -// to your router, the other to an AWS Direct Connect router. +// A connection links your internal network to an Direct Connect location over +// a standard Ethernet fiber-optic cable. One end of the cable is connected +// to your router, the other to an Direct Connect router. // // To find the locations for your Region, use DescribeLocations. // // You can automatically add the new connection to a link aggregation group // (LAG) by specifying a LAG ID in the request. This ensures that the new connection -// is allocated on the same AWS Direct Connect endpoint that hosts the specified +// is allocated on the same Direct Connect endpoint that hosts the specified // LAG. If there are no available ports on the endpoint, the request fails and // no connection is created. // @@ -1537,11 +1538,11 @@ func (c *DirectConnect) CreateDirectConnectGatewayRequest(input *CreateDirectCon // // Creates a Direct Connect gateway, which is an intermediate object that enables // you to connect a set of virtual interfaces and virtual private gateways. -// A Direct Connect gateway is global and visible in any AWS Region after it -// is created. The virtual interfaces and virtual private gateways that are -// connected through a Direct Connect gateway can be in different AWS Regions. -// This enables you to connect to a VPC in any Region, regardless of the Region -// in which the virtual interfaces are located, and pass traffic between them. +// A Direct Connect gateway is global and visible in any Region after it is +// created. The virtual interfaces and virtual private gateways that are connected +// through a Direct Connect gateway can be in different Regions. This enables +// you to connect to a VPC in any Region, regardless of the Region in which +// the virtual interfaces are located, and pass traffic between them. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1711,7 +1712,7 @@ func (c *DirectConnect) CreateDirectConnectGatewayAssociationProposalRequest(inp // transit gateway with the specified Direct Connect gateway. // // You can associate a Direct Connect gateway and virtual private gateway or -// transit gateway that is owned by any AWS account. +// transit gateway that is owned by any account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1793,29 +1794,29 @@ func (c *DirectConnect) CreateInterconnectRequest(input *CreateInterconnectInput // CreateInterconnect API operation for AWS Direct Connect. // -// Creates an interconnect between an AWS Direct Connect Partner's network and -// a specific AWS Direct Connect location. +// Creates an interconnect between an Direct Connect Partner's network and a +// specific Direct Connect location. // // An interconnect is a connection that is capable of hosting other connections. -// The AWS Direct Connect partner can use an interconnect to provide AWS Direct -// Connect hosted connections to customers through their own network services. -// Like a standard connection, an interconnect links the partner's network to -// an AWS Direct Connect location over a standard Ethernet fiber-optic cable. -// One end is connected to the partner's router, the other to an AWS Direct -// Connect router. +// The Direct Connect Partner can use an interconnect to provide Direct Connect +// hosted connections to customers through their own network services. Like +// a standard connection, an interconnect links the partner's network to an +// Direct Connect location over a standard Ethernet fiber-optic cable. One end +// is connected to the partner's router, the other to an Direct Connect router. // // You can automatically add the new interconnect to a link aggregation group // (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect -// is allocated on the same AWS Direct Connect endpoint that hosts the specified +// is allocated on the same Direct Connect endpoint that hosts the specified // LAG. If there are no available ports on the endpoint, the request fails and // no interconnect is created. // -// For each end customer, the AWS Direct Connect Partner provisions a connection +// For each end customer, the Direct Connect Partner provisions a connection // on their interconnect by calling AllocateHostedConnection. The end customer -// can then connect to AWS resources by creating a virtual interface on their -// connection, using the VLAN assigned to them by the AWS Direct Connect Partner. +// can then connect to Amazon Web Services resources by creating a virtual interface +// on their connection, using the VLAN assigned to them by the Direct Connect +// Partner. // -// Intended for use by AWS Direct Connect Partners only. +// Intended for use by Direct Connect Partners only. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1905,29 +1906,28 @@ func (c *DirectConnect) CreateLagRequest(input *CreateLagInput) (req *request.Re // // Creates a link aggregation group (LAG) with the specified number of bundled // physical dedicated connections between the customer network and a specific -// AWS Direct Connect location. A LAG is a logical interface that uses the Link +// Direct Connect location. A LAG is a logical interface that uses the Link // Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling // you to treat them as a single interface. // // All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) -// and must terminate at the same AWS Direct Connect endpoint. +// and must terminate at the same Direct Connect endpoint. // // You can have up to 10 dedicated connections per LAG. Regardless of this limit, -// if you request more connections for the LAG than AWS Direct Connect can allocate +// if you request more connections for the LAG than Direct Connect can allocate // on a single endpoint, no LAG is created. // // You can specify an existing physical dedicated connection or interconnect // to include in the LAG (which counts towards the total number of connections). // Doing so interrupts the current physical dedicated connection, and re-establishes -// them as a member of the LAG. The LAG will be created on the same AWS Direct -// Connect endpoint to which the dedicated connection terminates. Any virtual -// interfaces associated with the dedicated connection are automatically disassociated +// them as a member of the LAG. The LAG will be created on the same Direct Connect +// endpoint to which the dedicated connection terminates. Any virtual interfaces +// associated with the dedicated connection are automatically disassociated // and re-associated with the LAG. The connection ID does not change. // -// If the AWS account used to create a LAG is a registered AWS Direct Connect -// Partner, the LAG is automatically enabled to host sub-connections. For a -// LAG owned by a partner, any associated virtual interfaces cannot be directly -// configured. +// If the account used to create a LAG is a registered Direct Connect Partner, +// the LAG is automatically enabled to host sub-connections. For a LAG owned +// by a partner, any associated virtual interfaces cannot be directly configured. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2016,12 +2016,12 @@ func (c *DirectConnect) CreatePrivateVirtualInterfaceRequest(input *CreatePrivat // CreatePrivateVirtualInterface API operation for AWS Direct Connect. // // Creates a private virtual interface. A virtual interface is the VLAN that -// transports AWS Direct Connect traffic. A private virtual interface can be -// connected to either a Direct Connect gateway or a Virtual Private Gateway -// (VGW). Connecting the private virtual interface to a Direct Connect gateway -// enables the possibility for connecting to multiple VPCs, including VPCs in -// different AWS Regions. Connecting the private virtual interface to a VGW -// only provides access to a single VPC within the same Region. +// transports Direct Connect traffic. A private virtual interface can be connected +// to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting +// the private virtual interface to a Direct Connect gateway enables the possibility +// for connecting to multiple VPCs, including VPCs in different Regions. Connecting +// the private virtual interface to a VGW only provides access to a single VPC +// within the same Region. // // Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an // update to the underlying physical connection if it wasn't updated to support @@ -2117,8 +2117,8 @@ func (c *DirectConnect) CreatePublicVirtualInterfaceRequest(input *CreatePublicV // CreatePublicVirtualInterface API operation for AWS Direct Connect. // // Creates a public virtual interface. A virtual interface is the VLAN that -// transports AWS Direct Connect traffic. A public virtual interface supports -// sending traffic to public services of AWS such as Amazon S3. +// transports Direct Connect traffic. A public virtual interface supports sending +// traffic to public services of Amazon Web Services such as Amazon S3. // // When creating an IPv6 public virtual interface (addressFamily is ipv6), leave // the customer and amazon address fields blank to use auto-assigned IPv6 space. @@ -2401,10 +2401,9 @@ func (c *DirectConnect) DeleteConnectionRequest(input *DeleteConnectionInput) (r // // Deletes the specified connection. // -// Deleting a connection only stops the AWS Direct Connect port hour and data -// transfer charges. If you are partnering with any third parties to connect -// with the AWS Direct Connect location, you must cancel your service with them -// separately. +// Deleting a connection only stops the Direct Connect port hour and data transfer +// charges. If you are partnering with any third parties to connect with the +// Direct Connect location, you must cancel your service with them separately. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2743,7 +2742,7 @@ func (c *DirectConnect) DeleteInterconnectRequest(input *DeleteInterconnectInput // // Deletes the specified interconnect. // -// Intended for use by AWS Direct Connect Partners only. +// Intended for use by Direct Connect Partners only. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3001,9 +3000,10 @@ func (c *DirectConnect) DescribeConnectionLoaRequest(input *DescribeConnectionLo // // The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is // a document that your APN partner or service provider uses when establishing -// your cross connect to AWS at the colocation facility. For more information, -// see Requesting Cross Connects at AWS Direct Connect Locations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) -// in the AWS Direct Connect User Guide. +// your cross connect to Amazon Web Services at the colocation facility. For +// more information, see Requesting Cross Connects at Direct Connect Locations +// (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) +// in the Direct Connect User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3180,7 +3180,7 @@ func (c *DirectConnect) DescribeConnectionsOnInterconnectRequest(input *Describe // // Lists the connections that have been provisioned on the specified interconnect. // -// Intended for use by AWS Direct Connect Partners only. +// Intended for use by Direct Connect Partners only. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3620,7 +3620,7 @@ func (c *DirectConnect) DescribeHostedConnectionsRequest(input *DescribeHostedCo // Lists the hosted connections that have been provisioned on the specified // interconnect or link aggregation group (LAG). // -// Intended for use by AWS Direct Connect Partners only. +// Intended for use by Direct Connect Partners only. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3712,10 +3712,10 @@ func (c *DirectConnect) DescribeInterconnectLoaRequest(input *DescribeInterconne // Gets the LOA-CFA for the specified interconnect. // // The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is -// a document that is used when establishing your cross connect to AWS at the -// colocation facility. For more information, see Requesting Cross Connects -// at AWS Direct Connect Locations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) -// in the AWS Direct Connect User Guide. +// a document that is used when establishing your cross connect to Amazon Web +// Services at the colocation facility. For more information, see Requesting +// Cross Connects at Direct Connect Locations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) +// in the Direct Connect User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3801,7 +3801,7 @@ func (c *DirectConnect) DescribeInterconnectsRequest(input *DescribeInterconnect // DescribeInterconnects API operation for AWS Direct Connect. // -// Lists the interconnects owned by the AWS account or only the specified interconnect. +// Lists the interconnects owned by the account or only the specified interconnect. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3969,10 +3969,10 @@ func (c *DirectConnect) DescribeLoaRequest(input *DescribeLoaInput) (req *reques // (LAG). // // The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is -// a document that is used when establishing your cross connect to AWS at the -// colocation facility. For more information, see Requesting Cross Connects -// at AWS Direct Connect Locations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) -// in the AWS Direct Connect User Guide. +// a document that is used when establishing your cross connect to Amazon Web +// Services at the colocation facility. For more information, see Requesting +// Cross Connects at Direct Connect Locations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) +// in the Direct Connect User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4054,8 +4054,8 @@ func (c *DirectConnect) DescribeLocationsRequest(input *DescribeLocationsInput) // DescribeLocations API operation for AWS Direct Connect. // -// Lists the AWS Direct Connect locations in the current AWS Region. These are -// the locations that can be selected when calling CreateConnection or CreateInterconnect. +// Lists the Direct Connect locations in the current Region. These are the locations +// that can be selected when calling CreateConnection or CreateInterconnect. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4137,7 +4137,7 @@ func (c *DirectConnect) DescribeTagsRequest(input *DescribeTagsInput) (req *requ // DescribeTags API operation for AWS Direct Connect. // -// Describes the tags associated with the specified AWS Direct Connect resources. +// Describes the tags associated with the specified Direct Connect resources. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4219,10 +4219,10 @@ func (c *DirectConnect) DescribeVirtualGatewaysRequest(input *DescribeVirtualGat // DescribeVirtualGateways API operation for AWS Direct Connect. // -// Lists the virtual private gateways owned by the AWS account. +// Lists the virtual private gateways owned by the account. // -// You can create one or more AWS Direct Connect private virtual interfaces -// linked to a virtual private gateway. +// You can create one or more Direct Connect private virtual interfaces linked +// to a virtual private gateway. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4304,13 +4304,13 @@ func (c *DirectConnect) DescribeVirtualInterfacesRequest(input *DescribeVirtualI // DescribeVirtualInterfaces API operation for AWS Direct Connect. // -// Displays all virtual interfaces for an AWS account. Virtual interfaces deleted +// Displays all virtual interfaces for an account. Virtual interfaces deleted // fewer than 15 minutes before you make the request are also returned. If you // specify a connection ID, only the virtual interfaces associated with the // connection are returned. If you specify a virtual interface ID, then only // a single virtual interface is returned. // -// A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect +// A virtual interface (VLAN) transmits the traffic between the Direct Connect // location and the customer network. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4397,8 +4397,8 @@ func (c *DirectConnect) DisassociateConnectionFromLagRequest(input *Disassociate // is interrupted and re-established as a standalone connection (the connection // is not deleted; to delete the connection, use the DeleteConnection request). // If the LAG has associated virtual interfaces or hosted connections, they -// remain associated with the LAG. A disassociated connection owned by an AWS -// Direct Connect Partner is automatically converted to an interconnect. +// remain associated with the LAG. A disassociated connection owned by an Direct +// Connect Partner is automatically converted to an interconnect. // // If disassociating the connection would cause the LAG to fall below its setting // for minimum number of operational connections, the request fails, except @@ -4486,7 +4486,7 @@ func (c *DirectConnect) DisassociateMacSecKeyRequest(input *DisassociateMacSecKe // DisassociateMacSecKey API operation for AWS Direct Connect. // // Removes the association between a MAC Security (MACsec) security key and -// an AWS Direct Connect dedicated connection. +// an Direct Connect dedicated connection. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4825,8 +4825,8 @@ func (c *DirectConnect) TagResourceRequest(input *TagResourceInput) (req *reques // TagResource API operation for AWS Direct Connect. // -// Adds the specified tags to the specified AWS Direct Connect resource. Each -// resource can have a maximum of 50 tags. +// Adds the specified tags to the specified Direct Connect resource. Each resource +// can have a maximum of 50 tags. // // Each tag consists of a key and an optional value. If a tag with the same // key is already associated with the resource, this action updates its value. @@ -4918,7 +4918,7 @@ func (c *DirectConnect) UntagResourceRequest(input *UntagResourceInput) (req *re // UntagResource API operation for AWS Direct Connect. // -// Removes one or more tags from the specified AWS Direct Connect resource. +// Removes one or more tags from the specified Direct Connect resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5000,7 +5000,7 @@ func (c *DirectConnect) UpdateConnectionRequest(input *UpdateConnectionInput) (r // UpdateConnection API operation for AWS Direct Connect. // -// Updates the AWS Direct Connect dedicated connection configuration. +// Updates the Direct Connect dedicated connection configuration. // // You can update the following parameters for a connection: // @@ -5181,8 +5181,8 @@ func (c *DirectConnect) UpdateLagRequest(input *UpdateLagInput) (req *request.Re // * The value for the minimum number of connections that must be operational // for the LAG itself to be operational. // -// * The LAG's MACsec encryption mode. AWS assigns this value to each connection -// which is part of the LAG. +// * The LAG's MACsec encryption mode. Amazon Web Services assigns this value +// to each connection which is part of the LAG. // // * The tags // @@ -5318,8 +5318,7 @@ func (c *DirectConnect) UpdateVirtualInterfaceAttributesWithContext(ctx aws.Cont type AcceptDirectConnectGatewayAssociationProposalInput struct { _ struct{} `type:"structure"` - // The ID of the AWS account that owns the virtual private gateway or transit - // gateway. + // The ID of the account that owns the virtual private gateway or transit gateway. // // AssociatedGatewayOwnerAccount is a required field AssociatedGatewayOwnerAccount *string `locationName:"associatedGatewayOwnerAccount" type:"string" required:"true"` @@ -5332,7 +5331,7 @@ type AcceptDirectConnectGatewayAssociationProposalInput struct { // Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway. // // For information about how to set the prefixes, see Allowed Prefixes (https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes) - // in the AWS Direct Connect User Guide. + // in the Direct Connect User Guide. OverrideAllowedPrefixesToDirectConnectGateway []*RouteFilterPrefix `locationName:"overrideAllowedPrefixesToDirectConnectGateway" type:"list"` // The ID of the request proposal. @@ -5423,7 +5422,7 @@ type AllocateConnectionOnInterconnectInput struct { // The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, // 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note - // that only those AWS Direct Connect Partners who have met specific requirements + // that only those Direct Connect Partners who have met specific requirements // are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. // // Bandwidth is a required field @@ -5439,8 +5438,7 @@ type AllocateConnectionOnInterconnectInput struct { // InterconnectId is a required field InterconnectId *string `locationName:"interconnectId" type:"string" required:"true"` - // The ID of the AWS account of the customer for whom the connection will be - // provisioned. + // The ID of the account of the customer for whom the connection will be provisioned. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -5521,7 +5519,7 @@ type AllocateHostedConnectionInput struct { // The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, // 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note - // that only those AWS Direct Connect Partners who have met specific requirements + // that only those Direct Connect Partners who have met specific requirements // are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. // // Bandwidth is a required field @@ -5537,7 +5535,7 @@ type AllocateHostedConnectionInput struct { // ConnectionName is a required field ConnectionName *string `locationName:"connectionName" type:"string" required:"true"` - // The ID of the AWS account ID of the customer for the connection. + // The ID of the account ID of the customer for the connection. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -5648,7 +5646,7 @@ type AllocatePrivateVirtualInterfaceInput struct { // NewPrivateVirtualInterfaceAllocation is a required field NewPrivateVirtualInterfaceAllocation *NewPrivateVirtualInterfaceAllocation `locationName:"newPrivateVirtualInterfaceAllocation" type:"structure" required:"true"` - // The ID of the AWS account that owns the virtual private interface. + // The ID of the account that owns the virtual private interface. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -5719,7 +5717,7 @@ type AllocatePublicVirtualInterfaceInput struct { // NewPublicVirtualInterfaceAllocation is a required field NewPublicVirtualInterfaceAllocation *NewPublicVirtualInterfaceAllocation `locationName:"newPublicVirtualInterfaceAllocation" type:"structure" required:"true"` - // The ID of the AWS account that owns the public virtual interface. + // The ID of the account that owns the public virtual interface. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -5790,7 +5788,7 @@ type AllocateTransitVirtualInterfaceInput struct { // NewTransitVirtualInterfaceAllocation is a required field NewTransitVirtualInterfaceAllocation *NewTransitVirtualInterfaceAllocation `locationName:"newTransitVirtualInterfaceAllocation" type:"structure" required:"true"` - // The ID of the AWS account that owns the transit virtual interface. + // The ID of the account that owns the transit virtual interface. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -6154,8 +6152,8 @@ type AssociatedGateway struct { // The ID of the associated gateway. Id *string `locationName:"id" type:"string"` - // The ID of the AWS account that owns the associated virtual private gateway - // or transit gateway. + // The ID of the account that owns the associated virtual private gateway or + // transit gateway. OwnerAccount *string `locationName:"ownerAccount" type:"string"` // The Region where the associated gateway is located. @@ -6219,6 +6217,8 @@ type BGPPeer struct { // The Direct Connect endpoint on which the BGP peer terminates. AwsDeviceV2 *string `locationName:"awsDeviceV2" type:"string"` + AwsLogicalDeviceId *string `locationName:"awsLogicalDeviceId" type:"string"` + // The ID of the BGP peer. BgpPeerId *string `locationName:"bgpPeerId" type:"string"` @@ -6293,6 +6293,12 @@ func (s *BGPPeer) SetAwsDeviceV2(v string) *BGPPeer { return s } +// SetAwsLogicalDeviceId sets the AwsLogicalDeviceId field's value. +func (s *BGPPeer) SetAwsLogicalDeviceId(v string) *BGPPeer { + s.AwsLogicalDeviceId = &v + return s +} + // SetBgpPeerId sets the BgpPeerId field's value. func (s *BGPPeer) SetBgpPeerId(v string) *BGPPeer { s.BgpPeerId = &v @@ -6759,7 +6765,7 @@ func (s *ConfirmTransitVirtualInterfaceOutput) SetVirtualInterfaceState(v string return s } -// Information about an AWS Direct Connect connection. +// Information about an Direct Connect connection. type Connection struct { _ struct{} `type:"structure"` @@ -6769,6 +6775,9 @@ type Connection struct { // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string `locationName:"awsDeviceV2" type:"string"` + // The Direct Connect endpoint that terminates a physical connection's BGP sessions. + AwsLogicalDeviceId *string `locationName:"awsLogicalDeviceId" type:"string"` + // The bandwidth of the connection. Bandwidth *string `locationName:"bandwidth" type:"string"` @@ -6831,10 +6840,10 @@ type Connection struct { // The MAC Security (MACsec) security keys associated with the connection. MacSecKeys []*MacSecKey `locationName:"macSecKeys" type:"list"` - // The ID of the AWS account that owns the connection. + // The ID of the account that owns the connection. OwnerAccount *string `locationName:"ownerAccount" type:"string"` - // The name of the AWS Direct Connect service provider associated with the connection. + // The name of the Direct Connect service provider associated with the connection. PartnerName *string `locationName:"partnerName" type:"string"` // The MAC Security (MACsec) port link status of the connection. @@ -6846,7 +6855,7 @@ type Connection struct { // The name of the service provider associated with the connection. ProviderName *string `locationName:"providerName" type:"string"` - // The AWS Region where the connection is located. + // The Region where the connection is located. Region *string `locationName:"region" type:"string"` // The tags associated with the connection. @@ -6878,6 +6887,12 @@ func (s *Connection) SetAwsDeviceV2(v string) *Connection { return s } +// SetAwsLogicalDeviceId sets the AwsLogicalDeviceId field's value. +func (s *Connection) SetAwsLogicalDeviceId(v string) *Connection { + s.AwsLogicalDeviceId = &v + return s +} + // SetBandwidth sets the Bandwidth field's value. func (s *Connection) SetBandwidth(v string) *Connection { s.Bandwidth = &v @@ -7098,7 +7113,7 @@ type CreateConnectionInput struct { // // MAC Security (MACsec) is only available on dedicated connections. For information // about MAC Security (MACsec) prerequisties, see MACsec prerequisties (https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites) - // in the AWS Direct Connect User Guide. + // in the Direct Connect User Guide. RequestMACSec *bool `locationName:"requestMACSec" type:"boolean"` // The tags to associate with the lag. @@ -7197,7 +7212,7 @@ type CreateDirectConnectGatewayAssociationInput struct { // This parameter is required when you create an association to a transit gateway. // // For information about how to set the prefixes, see Allowed Prefixes (https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes) - // in the AWS Direct Connect User Guide. + // in the Direct Connect User Guide. AddAllowedPrefixesToDirectConnectGateway []*RouteFilterPrefix `locationName:"addAllowedPrefixesToDirectConnectGateway" type:"list"` // The ID of the Direct Connect gateway. @@ -7293,7 +7308,7 @@ type CreateDirectConnectGatewayAssociationProposalInput struct { // DirectConnectGatewayId is a required field DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string" required:"true"` - // The ID of the AWS account that owns the Direct Connect gateway. + // The ID of the account that owns the Direct Connect gateway. // // DirectConnectGatewayOwnerAccount is a required field DirectConnectGatewayOwnerAccount *string `locationName:"directConnectGatewayOwnerAccount" type:"string" required:"true"` @@ -7607,7 +7622,7 @@ type CreateLagInput struct { // All connections in the LAG must be capable of supporting MAC Security (MACsec). // For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties // (https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites) - // in the AWS Direct Connect User Guide. + // in the Direct Connect User Guide. RequestMACSec *bool `locationName:"requestMACSec" type:"boolean"` // The tags to associate with the LAG. @@ -9609,7 +9624,7 @@ type Gateway struct { // * deleted: The Direct Connect gateway is deleted and cannot pass traffic. DirectConnectGatewayState *string `locationName:"directConnectGatewayState" type:"string" enum:"GatewayState"` - // The ID of the AWS account that owns the Direct Connect gateway. + // The ID of the account that owns the Direct Connect gateway. OwnerAccount *string `locationName:"ownerAccount" type:"string"` // The error message if the state of an object failed to advance. @@ -9693,7 +9708,7 @@ type GatewayAssociation struct { // The ID of the Direct Connect gateway. DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string"` - // The ID of the AWS account that owns the associated gateway. + // The ID of the account that owns the associated gateway. DirectConnectGatewayOwnerAccount *string `locationName:"directConnectGatewayOwnerAccount" type:"string"` // The error message if the state of an object failed to advance. @@ -9702,10 +9717,10 @@ type GatewayAssociation struct { // The ID of the virtual private gateway. Applies only to private virtual interfaces. VirtualGatewayId *string `locationName:"virtualGatewayId" type:"string"` - // The ID of the AWS account that owns the virtual private gateway. + // The ID of the account that owns the virtual private gateway. VirtualGatewayOwnerAccount *string `locationName:"virtualGatewayOwnerAccount" type:"string"` - // The AWS Region where the virtual private gateway is located. + // The Region where the virtual private gateway is located. VirtualGatewayRegion *string `locationName:"virtualGatewayRegion" deprecated:"true" type:"string"` } @@ -9790,7 +9805,7 @@ type GatewayAssociationProposal struct { // The ID of the Direct Connect gateway. DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string"` - // The ID of the AWS account that owns the Direct Connect gateway. + // The ID of the account that owns the Direct Connect gateway. DirectConnectGatewayOwnerAccount *string `locationName:"directConnectGatewayOwnerAccount" type:"string"` // The existing Amazon VPC prefixes advertised to the Direct Connect gateway. @@ -9899,10 +9914,10 @@ type GatewayAttachment struct { // The ID of the virtual interface. VirtualInterfaceId *string `locationName:"virtualInterfaceId" type:"string"` - // The ID of the AWS account that owns the virtual interface. + // The ID of the account that owns the virtual interface. VirtualInterfaceOwnerAccount *string `locationName:"virtualInterfaceOwnerAccount" type:"string"` - // The AWS Region where the virtual interface is located. + // The Region where the virtual interface is located. VirtualInterfaceRegion *string `locationName:"virtualInterfaceRegion" type:"string"` } @@ -9968,6 +9983,9 @@ type Interconnect struct { // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string `locationName:"awsDeviceV2" type:"string"` + // The Direct Connect endpoint that terminates a physical connection's BGP sessions. + AwsLogicalDeviceId *string `locationName:"awsLogicalDeviceId" type:"string"` + // The bandwidth of the connection. Bandwidth *string `locationName:"bandwidth" type:"string"` @@ -10016,7 +10034,7 @@ type Interconnect struct { // The name of the service provider associated with the interconnect. ProviderName *string `locationName:"providerName" type:"string"` - // The AWS Region where the connection is located. + // The Region where the connection is located. Region *string `locationName:"region" type:"string"` // The tags associated with the interconnect. @@ -10045,6 +10063,12 @@ func (s *Interconnect) SetAwsDeviceV2(v string) *Interconnect { return s } +// SetAwsLogicalDeviceId sets the AwsLogicalDeviceId field's value. +func (s *Interconnect) SetAwsLogicalDeviceId(v string) *Interconnect { + s.AwsLogicalDeviceId = &v + return s +} + // SetBandwidth sets the Bandwidth field's value. func (s *Interconnect) SetBandwidth(v string) *Interconnect { s.Bandwidth = &v @@ -10124,12 +10148,15 @@ type Lag struct { // Indicates whether the LAG can host other connections. AllowsHostedConnections *bool `locationName:"allowsHostedConnections" type:"boolean"` - // The AWS Direct Connect endpoint that hosts the LAG. + // The Direct Connect endpoint that hosts the LAG. AwsDevice *string `locationName:"awsDevice" deprecated:"true" type:"string"` - // The AWS Direct Connect endpoint that hosts the LAG. + // The Direct Connect endpoint that hosts the LAG. AwsDeviceV2 *string `locationName:"awsDeviceV2" type:"string"` + // The Direct Connect endpoint that terminates a physical connection's BGP sessions. + AwsLogicalDeviceId *string `locationName:"awsLogicalDeviceId" type:"string"` + // The connections bundled by the LAG. Connections []*Connection `locationName:"connections" type:"list"` @@ -10191,13 +10218,13 @@ type Lag struct { // maximum of 10. NumberOfConnections *int64 `locationName:"numberOfConnections" type:"integer"` - // The ID of the AWS account that owns the LAG. + // The ID of the account that owns the LAG. OwnerAccount *string `locationName:"ownerAccount" type:"string"` // The name of the service provider associated with the LAG. ProviderName *string `locationName:"providerName" type:"string"` - // The AWS Region where the connection is located. + // The Region where the connection is located. Region *string `locationName:"region" type:"string"` // The tags associated with the LAG. @@ -10232,6 +10259,12 @@ func (s *Lag) SetAwsDeviceV2(v string) *Lag { return s } +// SetAwsLogicalDeviceId sets the AwsLogicalDeviceId field's value. +func (s *Lag) SetAwsLogicalDeviceId(v string) *Lag { + s.AwsLogicalDeviceId = &v + return s +} + // SetConnections sets the Connections field's value. func (s *Lag) SetConnections(v []*Connection) *Lag { s.Connections = v @@ -10476,7 +10509,7 @@ func (s *Loa) SetLoaContentType(v string) *Loa { return s } -// Information about an AWS Direct Connect location. +// Information about an Direct Connect location. type Location struct { _ struct{} `type:"structure"` @@ -10496,7 +10529,7 @@ type Location struct { // and the physical site of the building. LocationName *string `locationName:"locationName" type:"string"` - // The AWS Region for the location. + // The Region for the location. Region *string `locationName:"region" type:"string"` } @@ -10995,8 +11028,8 @@ type NewPublicVirtualInterface struct { // The IP address assigned to the customer interface. CustomerAddress *string `locationName:"customerAddress" type:"string"` - // The routes to be advertised to the AWS network in this Region. Applies to - // public virtual interfaces. + // The routes to be advertised to the Amazon Web Services network in this Region. + // Applies to public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` // The tags associated with the public virtual interface. @@ -11135,8 +11168,8 @@ type NewPublicVirtualInterfaceAllocation struct { // The IP address assigned to the customer interface. CustomerAddress *string `locationName:"customerAddress" type:"string"` - // The routes to be advertised to the AWS network in this Region. Applies to - // public virtual interfaces. + // The routes to be advertised to the Amazon Web Services network in this Region. + // Applies to public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` // The tags associated with the public virtual interface. @@ -11510,7 +11543,7 @@ func (s *NewTransitVirtualInterfaceAllocation) SetVlan(v int64) *NewTransitVirtu return s } -// Information about a tag associated with an AWS Direct Connect resource. +// Information about a tag associated with an Direct Connect resource. type ResourceTag struct { _ struct{} `type:"structure"` @@ -12081,7 +12114,7 @@ func (s *UpdateConnectionInput) SetEncryptionMode(v string) *UpdateConnectionInp return s } -// Information about an AWS Direct Connect connection. +// Information about an Direct Connect connection. type UpdateConnectionOutput struct { _ struct{} `type:"structure"` @@ -12091,6 +12124,9 @@ type UpdateConnectionOutput struct { // The Direct Connect endpoint on which the physical connection terminates. AwsDeviceV2 *string `locationName:"awsDeviceV2" type:"string"` + // The Direct Connect endpoint that terminates a physical connection's BGP sessions. + AwsLogicalDeviceId *string `locationName:"awsLogicalDeviceId" type:"string"` + // The bandwidth of the connection. Bandwidth *string `locationName:"bandwidth" type:"string"` @@ -12153,10 +12189,10 @@ type UpdateConnectionOutput struct { // The MAC Security (MACsec) security keys associated with the connection. MacSecKeys []*MacSecKey `locationName:"macSecKeys" type:"list"` - // The ID of the AWS account that owns the connection. + // The ID of the account that owns the connection. OwnerAccount *string `locationName:"ownerAccount" type:"string"` - // The name of the AWS Direct Connect service provider associated with the connection. + // The name of the Direct Connect service provider associated with the connection. PartnerName *string `locationName:"partnerName" type:"string"` // The MAC Security (MACsec) port link status of the connection. @@ -12168,7 +12204,7 @@ type UpdateConnectionOutput struct { // The name of the service provider associated with the connection. ProviderName *string `locationName:"providerName" type:"string"` - // The AWS Region where the connection is located. + // The Region where the connection is located. Region *string `locationName:"region" type:"string"` // The tags associated with the connection. @@ -12200,6 +12236,12 @@ func (s *UpdateConnectionOutput) SetAwsDeviceV2(v string) *UpdateConnectionOutpu return s } +// SetAwsLogicalDeviceId sets the AwsLogicalDeviceId field's value. +func (s *UpdateConnectionOutput) SetAwsLogicalDeviceId(v string) *UpdateConnectionOutput { + s.AwsLogicalDeviceId = &v + return s +} + // SetBandwidth sets the Bandwidth field's value. func (s *UpdateConnectionOutput) SetBandwidth(v string) *UpdateConnectionOutput { s.Bandwidth = &v @@ -12384,7 +12426,8 @@ type UpdateLagInput struct { // The LAG MAC Security (MACsec) encryption mode. // - // AWS applies the value to all connections which are part of the LAG. + // Amazon Web Services applies the value to all connections which are part of + // the LAG. EncryptionMode *string `locationName:"encryptionMode" type:"string"` // The ID of the LAG. @@ -12520,6 +12563,9 @@ type UpdateVirtualInterfaceAttributesOutput struct { // The Direct Connect endpoint on which the virtual interface terminates. AwsDeviceV2 *string `locationName:"awsDeviceV2" type:"string"` + // The Direct Connect endpoint that terminates a physical connection's BGP sessions. + AwsLogicalDeviceId *string `locationName:"awsLogicalDeviceId" type:"string"` + // The BGP peers configured on this virtual interface. BgpPeers []*BGPPeer `locationName:"bgpPeers" type:"list"` @@ -12545,14 +12591,14 @@ type UpdateVirtualInterfaceAttributesOutput struct { // and 9001. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` - // The ID of the AWS account that owns the virtual interface. + // The ID of the account that owns the virtual interface. OwnerAccount *string `locationName:"ownerAccount" type:"string"` - // The AWS Region where the virtual interface is located. + // The Region where the virtual interface is located. Region *string `locationName:"region" type:"string"` - // The routes to be advertised to the AWS network in this Region. Applies to - // public virtual interfaces. + // The routes to be advertised to the Amazon Web Services network in this Region. + // Applies to public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` // The tags associated with the virtual interface. @@ -12654,6 +12700,12 @@ func (s *UpdateVirtualInterfaceAttributesOutput) SetAwsDeviceV2(v string) *Updat return s } +// SetAwsLogicalDeviceId sets the AwsLogicalDeviceId field's value. +func (s *UpdateVirtualInterfaceAttributesOutput) SetAwsLogicalDeviceId(v string) *UpdateVirtualInterfaceAttributesOutput { + s.AwsLogicalDeviceId = &v + return s +} + // SetBgpPeers sets the BgpPeers field's value. func (s *UpdateVirtualInterfaceAttributesOutput) SetBgpPeers(v []*BGPPeer) *UpdateVirtualInterfaceAttributesOutput { s.BgpPeers = v @@ -12830,6 +12882,9 @@ type VirtualInterface struct { // The Direct Connect endpoint on which the virtual interface terminates. AwsDeviceV2 *string `locationName:"awsDeviceV2" type:"string"` + // The Direct Connect endpoint that terminates a physical connection's BGP sessions. + AwsLogicalDeviceId *string `locationName:"awsLogicalDeviceId" type:"string"` + // The BGP peers configured on this virtual interface. BgpPeers []*BGPPeer `locationName:"bgpPeers" type:"list"` @@ -12855,14 +12910,14 @@ type VirtualInterface struct { // and 9001. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` - // The ID of the AWS account that owns the virtual interface. + // The ID of the account that owns the virtual interface. OwnerAccount *string `locationName:"ownerAccount" type:"string"` - // The AWS Region where the virtual interface is located. + // The Region where the virtual interface is located. Region *string `locationName:"region" type:"string"` - // The routes to be advertised to the AWS network in this Region. Applies to - // public virtual interfaces. + // The routes to be advertised to the Amazon Web Services network in this Region. + // Applies to public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` // The tags associated with the virtual interface. @@ -12964,6 +13019,12 @@ func (s *VirtualInterface) SetAwsDeviceV2(v string) *VirtualInterface { return s } +// SetAwsLogicalDeviceId sets the AwsLogicalDeviceId field's value. +func (s *VirtualInterface) SetAwsLogicalDeviceId(v string) *VirtualInterface { + s.AwsLogicalDeviceId = &v + return s +} + // SetBgpPeers sets the BgpPeers field's value. func (s *VirtualInterface) SetBgpPeers(v []*BGPPeer) *VirtualInterface { s.BgpPeers = v diff --git a/service/directconnect/doc.go b/service/directconnect/doc.go index de61cdbfa78..47a5c5d099b 100644 --- a/service/directconnect/doc.go +++ b/service/directconnect/doc.go @@ -3,15 +3,15 @@ // Package directconnect provides the client and types for making API // requests to AWS Direct Connect. // -// AWS Direct Connect links your internal network to an AWS Direct Connect location +// Direct Connect links your internal network to an Direct Connect location // over a standard Ethernet fiber-optic cable. One end of the cable is connected -// to your router, the other to an AWS Direct Connect router. With this connection -// in place, you can create virtual interfaces directly to the AWS cloud (for -// example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet -// service providers in your network path. A connection provides access to all -// AWS Regions except the China (Beijing) and (China) Ningxia Regions. AWS resources -// in the China Regions can only be accessed through locations associated with -// those Regions. +// to your router, the other to an Direct Connect router. With this connection +// in place, you can create virtual interfaces directly to the Cloud (for example, +// to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service +// providers in your network path. A connection provides access to all Regions +// except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services +// resources in the China Regions can only be accessed through locations associated +// with those Regions. // // See https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25 for more information on this service. // diff --git a/service/lexmodelbuildingservice/api.go b/service/lexmodelbuildingservice/api.go index 4fdba3fb058..77589ef998e 100644 --- a/service/lexmodelbuildingservice/api.go +++ b/service/lexmodelbuildingservice/api.go @@ -3209,6 +3209,242 @@ func (c *LexModelBuildingService) GetIntentsPagesWithContext(ctx aws.Context, in return p.Err() } +const opGetMigration = "GetMigration" + +// GetMigrationRequest generates a "aws/request.Request" representing the +// client's request for the GetMigration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetMigration for more information on using the GetMigration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetMigrationRequest method. +// req, resp := client.GetMigrationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/GetMigration +func (c *LexModelBuildingService) GetMigrationRequest(input *GetMigrationInput) (req *request.Request, output *GetMigrationOutput) { + op := &request.Operation{ + Name: opGetMigration, + HTTPMethod: "GET", + HTTPPath: "/migrations/{migrationId}", + } + + if input == nil { + input = &GetMigrationInput{} + } + + output = &GetMigrationOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetMigration API operation for Amazon Lex Model Building Service. +// +// Provides details about an ongoing or complete migration from an Amazon Lex +// V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration +// alerts and warnings related to the migration. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lex Model Building Service's +// API operation GetMigration for usage and error information. +// +// Returned Error Types: +// * LimitExceededException +// The request exceeded a limit. Try your request again. +// +// * InternalFailureException +// An internal Amazon Lex error occurred. Try your request again. +// +// * BadRequestException +// The request is not well formed. For example, a value is invalid or a required +// field is missing. Check the field values, and try again. +// +// * NotFoundException +// The resource specified in the request was not found. Check the resource and +// try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/GetMigration +func (c *LexModelBuildingService) GetMigration(input *GetMigrationInput) (*GetMigrationOutput, error) { + req, out := c.GetMigrationRequest(input) + return out, req.Send() +} + +// GetMigrationWithContext is the same as GetMigration with the addition of +// the ability to pass a context and additional request options. +// +// See GetMigration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LexModelBuildingService) GetMigrationWithContext(ctx aws.Context, input *GetMigrationInput, opts ...request.Option) (*GetMigrationOutput, error) { + req, out := c.GetMigrationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetMigrations = "GetMigrations" + +// GetMigrationsRequest generates a "aws/request.Request" representing the +// client's request for the GetMigrations operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetMigrations for more information on using the GetMigrations +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetMigrationsRequest method. +// req, resp := client.GetMigrationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/GetMigrations +func (c *LexModelBuildingService) GetMigrationsRequest(input *GetMigrationsInput) (req *request.Request, output *GetMigrationsOutput) { + op := &request.Operation{ + Name: opGetMigrations, + HTTPMethod: "GET", + HTTPPath: "/migrations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetMigrationsInput{} + } + + output = &GetMigrationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetMigrations API operation for Amazon Lex Model Building Service. +// +// Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lex Model Building Service's +// API operation GetMigrations for usage and error information. +// +// Returned Error Types: +// * LimitExceededException +// The request exceeded a limit. Try your request again. +// +// * InternalFailureException +// An internal Amazon Lex error occurred. Try your request again. +// +// * BadRequestException +// The request is not well formed. For example, a value is invalid or a required +// field is missing. Check the field values, and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/GetMigrations +func (c *LexModelBuildingService) GetMigrations(input *GetMigrationsInput) (*GetMigrationsOutput, error) { + req, out := c.GetMigrationsRequest(input) + return out, req.Send() +} + +// GetMigrationsWithContext is the same as GetMigrations with the addition of +// the ability to pass a context and additional request options. +// +// See GetMigrations for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LexModelBuildingService) GetMigrationsWithContext(ctx aws.Context, input *GetMigrationsInput, opts ...request.Option) (*GetMigrationsOutput, error) { + req, out := c.GetMigrationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetMigrationsPages iterates over the pages of a GetMigrations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetMigrations method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a GetMigrations operation. +// pageNum := 0 +// err := client.GetMigrationsPages(params, +// func(page *lexmodelbuildingservice.GetMigrationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *LexModelBuildingService) GetMigrationsPages(input *GetMigrationsInput, fn func(*GetMigrationsOutput, bool) bool) error { + return c.GetMigrationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetMigrationsPagesWithContext same as GetMigrationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LexModelBuildingService) GetMigrationsPagesWithContext(ctx aws.Context, input *GetMigrationsInput, fn func(*GetMigrationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetMigrationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetMigrationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetMigrationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opGetSlotType = "GetSlotType" // GetSlotTypeRequest generates a "aws/request.Request" representing the @@ -3681,8 +3917,9 @@ func (c *LexModelBuildingService) GetUtterancesViewRequest(input *GetUtterancesV // by the bot in the last 15 days. The response contains information about a // maximum of 100 utterances for each version. // -// If you set childDirected field to true when you created your bot, or if you -// opted out of participating in improving Amazon Lex, utterances are not available. +// If you set childDirected field to true when you created your bot, if you +// are using slot obfuscation with one or more slots, or if you opted out of +// participating in improving Amazon Lex, utterances are not available. // // This operation requires permissions for the lex:GetUtterancesView action. // @@ -4353,6 +4590,104 @@ func (c *LexModelBuildingService) StartImportWithContext(ctx aws.Context, input return out, req.Send() } +const opStartMigration = "StartMigration" + +// StartMigrationRequest generates a "aws/request.Request" representing the +// client's request for the StartMigration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartMigration for more information on using the StartMigration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StartMigrationRequest method. +// req, resp := client.StartMigrationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/StartMigration +func (c *LexModelBuildingService) StartMigrationRequest(input *StartMigrationInput) (req *request.Request, output *StartMigrationOutput) { + op := &request.Operation{ + Name: opStartMigration, + HTTPMethod: "POST", + HTTPPath: "/migrations", + } + + if input == nil { + input = &StartMigrationInput{} + } + + output = &StartMigrationOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartMigration API operation for Amazon Lex Model Building Service. +// +// Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your +// bot when you want to take advantage of the new features of Amazon Lex V2. +// +// For more information, see Migrating a bot (https://docs.aws.amazon.com/lex/latest/dg/migrate.html) +// in the Amazon Lex developer guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lex Model Building Service's +// API operation StartMigration for usage and error information. +// +// Returned Error Types: +// * LimitExceededException +// The request exceeded a limit. Try your request again. +// +// * InternalFailureException +// An internal Amazon Lex error occurred. Try your request again. +// +// * BadRequestException +// The request is not well formed. For example, a value is invalid or a required +// field is missing. Check the field values, and try again. +// +// * AccessDeniedException +// Your IAM user or role does not have permission to call the Amazon Lex V2 +// APIs required to migrate your bot. +// +// * NotFoundException +// The resource specified in the request was not found. Check the resource and +// try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/StartMigration +func (c *LexModelBuildingService) StartMigration(input *StartMigrationInput) (*StartMigrationOutput, error) { + req, out := c.StartMigrationRequest(input) + return out, req.Send() +} + +// StartMigrationWithContext is the same as StartMigration with the addition of +// the ability to pass a context and additional request options. +// +// See StartMigration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LexModelBuildingService) StartMigrationWithContext(ctx aws.Context, input *StartMigrationInput, opts ...request.Option) (*StartMigrationOutput, error) { + req, out := c.StartMigrationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opTagResource = "TagResource" // TagResourceRequest generates a "aws/request.Request" representing the @@ -4542,6 +4877,63 @@ func (c *LexModelBuildingService) UntagResourceWithContext(ctx aws.Context, inpu return out, req.Send() } +// Your IAM user or role does not have permission to call the Amazon Lex V2 +// APIs required to migrate your bot. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s AccessDeniedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + // The request is not well formed. For example, a value is invalid or a required // field is missing. Check the field values, and try again. type BadRequestException struct { @@ -8665,23 +9057,291 @@ type GetIntentsInput struct { } // String returns the string representation -func (s GetIntentsInput) String() string { +func (s GetIntentsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetIntentsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetIntentsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetIntentsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NameContains != nil && len(*s.NameContains) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NameContains", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetIntentsInput) SetMaxResults(v int64) *GetIntentsInput { + s.MaxResults = &v + return s +} + +// SetNameContains sets the NameContains field's value. +func (s *GetIntentsInput) SetNameContains(v string) *GetIntentsInput { + s.NameContains = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIntentsInput) SetNextToken(v string) *GetIntentsInput { + s.NextToken = &v + return s +} + +type GetIntentsOutput struct { + _ struct{} `type:"structure"` + + // An array of Intent objects. For more information, see PutBot. + Intents []*IntentMetadata `locationName:"intents" type:"list"` + + // If the response is truncated, the response includes a pagination token that + // you can specify in your next request to fetch the next page of intents. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s GetIntentsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetIntentsOutput) GoString() string { + return s.String() +} + +// SetIntents sets the Intents field's value. +func (s *GetIntentsOutput) SetIntents(v []*IntentMetadata) *GetIntentsOutput { + s.Intents = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIntentsOutput) SetNextToken(v string) *GetIntentsOutput { + s.NextToken = &v + return s +} + +type GetMigrationInput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the migration to view. The migrationID is returned + // by the operation. + // + // MigrationId is a required field + MigrationId *string `location:"uri" locationName:"migrationId" min:"10" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetMigrationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetMigrationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetMigrationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetMigrationInput"} + if s.MigrationId == nil { + invalidParams.Add(request.NewErrParamRequired("MigrationId")) + } + if s.MigrationId != nil && len(*s.MigrationId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("MigrationId", 10)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMigrationId sets the MigrationId field's value. +func (s *GetMigrationInput) SetMigrationId(v string) *GetMigrationInput { + s.MigrationId = &v + return s +} + +type GetMigrationOutput struct { + _ struct{} `type:"structure"` + + // A list of alerts and warnings that indicate issues with the migration for + // the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon + // Lex V1 feature has a different implementation if Amazon Lex V2. + // + // For more information, see Migrating a bot (https://docs.aws.amazon.com/lexv2/latest/dg/migrate.html) + // in the Amazon Lex V2 developer guide. + Alerts []*MigrationAlert `locationName:"alerts" type:"list"` + + // The unique identifier of the migration. This is the same as the identifier + // used when calling the GetMigration operation. + MigrationId *string `locationName:"migrationId" min:"10" type:"string"` + + // Indicates the status of the migration. When the status is COMPLETE the migration + // is finished and the bot is available in Amazon Lex V2. There may be alerts + // and warnings that need to be resolved to complete the migration. + MigrationStatus *string `locationName:"migrationStatus" type:"string" enum:"MigrationStatus"` + + // The strategy used to conduct the migration. + // + // * CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon + // Lex V1 bot to the new bot. + // + // * UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata + // and the locale being migrated. It doesn't change any other locales in + // the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created + // in the Amazon Lex V2 bot. + MigrationStrategy *string `locationName:"migrationStrategy" type:"string" enum:"MigrationStrategy"` + + // The date and time that the migration started. + MigrationTimestamp *time.Time `locationName:"migrationTimestamp" type:"timestamp"` + + // The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2. + V1BotLocale *string `locationName:"v1BotLocale" type:"string" enum:"Locale"` + + // The name of the Amazon Lex V1 bot migrated to Amazon Lex V2. + V1BotName *string `locationName:"v1BotName" min:"2" type:"string"` + + // The version of the Amazon Lex V1 bot migrated to Amazon Lex V2. + V1BotVersion *string `locationName:"v1BotVersion" min:"1" type:"string"` + + // The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is + // being migrated to. + V2BotId *string `locationName:"v2BotId" min:"10" type:"string"` + + // The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot. + V2BotRole *string `locationName:"v2BotRole" min:"20" type:"string"` +} + +// String returns the string representation +func (s GetMigrationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetMigrationOutput) GoString() string { + return s.String() +} + +// SetAlerts sets the Alerts field's value. +func (s *GetMigrationOutput) SetAlerts(v []*MigrationAlert) *GetMigrationOutput { + s.Alerts = v + return s +} + +// SetMigrationId sets the MigrationId field's value. +func (s *GetMigrationOutput) SetMigrationId(v string) *GetMigrationOutput { + s.MigrationId = &v + return s +} + +// SetMigrationStatus sets the MigrationStatus field's value. +func (s *GetMigrationOutput) SetMigrationStatus(v string) *GetMigrationOutput { + s.MigrationStatus = &v + return s +} + +// SetMigrationStrategy sets the MigrationStrategy field's value. +func (s *GetMigrationOutput) SetMigrationStrategy(v string) *GetMigrationOutput { + s.MigrationStrategy = &v + return s +} + +// SetMigrationTimestamp sets the MigrationTimestamp field's value. +func (s *GetMigrationOutput) SetMigrationTimestamp(v time.Time) *GetMigrationOutput { + s.MigrationTimestamp = &v + return s +} + +// SetV1BotLocale sets the V1BotLocale field's value. +func (s *GetMigrationOutput) SetV1BotLocale(v string) *GetMigrationOutput { + s.V1BotLocale = &v + return s +} + +// SetV1BotName sets the V1BotName field's value. +func (s *GetMigrationOutput) SetV1BotName(v string) *GetMigrationOutput { + s.V1BotName = &v + return s +} + +// SetV1BotVersion sets the V1BotVersion field's value. +func (s *GetMigrationOutput) SetV1BotVersion(v string) *GetMigrationOutput { + s.V1BotVersion = &v + return s +} + +// SetV2BotId sets the V2BotId field's value. +func (s *GetMigrationOutput) SetV2BotId(v string) *GetMigrationOutput { + s.V2BotId = &v + return s +} + +// SetV2BotRole sets the V2BotRole field's value. +func (s *GetMigrationOutput) SetV2BotRole(v string) *GetMigrationOutput { + s.V2BotRole = &v + return s +} + +type GetMigrationsInput struct { + _ struct{} `type:"structure"` + + // The maximum number of migrations to return in the response. The default is + // 10. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // Filters the list to contain only migrations in the specified state. + MigrationStatusEquals *string `location:"querystring" locationName:"migrationStatusEquals" type:"string" enum:"MigrationStatus"` + + // A pagination token that fetches the next page of migrations. If the response + // to this operation is truncated, Amazon Lex returns a pagination token in + // the response. To fetch the next page of migrations, specify the pagination + // token in the request. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + + // The field to sort the list of migrations by. You can sort by the Amazon Lex + // V1 bot name or the date and time that the migration was started. + SortByAttribute *string `location:"querystring" locationName:"sortByAttribute" type:"string" enum:"MigrationSortAttribute"` + + // The order so sort the list. + SortByOrder *string `location:"querystring" locationName:"sortByOrder" type:"string" enum:"SortOrder"` + + // Filters the list to contain only bots whose name contains the specified string. + // The string is matched anywhere in bot name. + V1BotNameContains *string `location:"querystring" locationName:"v1BotNameContains" min:"2" type:"string"` +} + +// String returns the string representation +func (s GetMigrationsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s GetIntentsInput) GoString() string { +func (s GetMigrationsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetIntentsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetIntentsInput"} +func (s *GetMigrationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetMigrationsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } - if s.NameContains != nil && len(*s.NameContains) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NameContains", 1)) + if s.V1BotNameContains != nil && len(*s.V1BotNameContains) < 2 { + invalidParams.Add(request.NewErrParamMinLen("V1BotNameContains", 2)) } if invalidParams.Len() > 0 { @@ -8691,52 +9351,72 @@ func (s *GetIntentsInput) Validate() error { } // SetMaxResults sets the MaxResults field's value. -func (s *GetIntentsInput) SetMaxResults(v int64) *GetIntentsInput { +func (s *GetMigrationsInput) SetMaxResults(v int64) *GetMigrationsInput { s.MaxResults = &v return s } -// SetNameContains sets the NameContains field's value. -func (s *GetIntentsInput) SetNameContains(v string) *GetIntentsInput { - s.NameContains = &v +// SetMigrationStatusEquals sets the MigrationStatusEquals field's value. +func (s *GetMigrationsInput) SetMigrationStatusEquals(v string) *GetMigrationsInput { + s.MigrationStatusEquals = &v return s } // SetNextToken sets the NextToken field's value. -func (s *GetIntentsInput) SetNextToken(v string) *GetIntentsInput { +func (s *GetMigrationsInput) SetNextToken(v string) *GetMigrationsInput { s.NextToken = &v return s } -type GetIntentsOutput struct { +// SetSortByAttribute sets the SortByAttribute field's value. +func (s *GetMigrationsInput) SetSortByAttribute(v string) *GetMigrationsInput { + s.SortByAttribute = &v + return s +} + +// SetSortByOrder sets the SortByOrder field's value. +func (s *GetMigrationsInput) SetSortByOrder(v string) *GetMigrationsInput { + s.SortByOrder = &v + return s +} + +// SetV1BotNameContains sets the V1BotNameContains field's value. +func (s *GetMigrationsInput) SetV1BotNameContains(v string) *GetMigrationsInput { + s.V1BotNameContains = &v + return s +} + +type GetMigrationsOutput struct { _ struct{} `type:"structure"` - // An array of Intent objects. For more information, see PutBot. - Intents []*IntentMetadata `locationName:"intents" type:"list"` + // An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. + // To see details of the migration, use the migrationId from the summary in + // a call to the operation. + MigrationSummaries []*MigrationSummary `locationName:"migrationSummaries" type:"list"` - // If the response is truncated, the response includes a pagination token that - // you can specify in your next request to fetch the next page of intents. + // If the response is truncated, it includes a pagination token that you can + // specify in your next request to fetch the next page of migrations. NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation -func (s GetIntentsOutput) String() string { +func (s GetMigrationsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s GetIntentsOutput) GoString() string { +func (s GetMigrationsOutput) GoString() string { return s.String() } -// SetIntents sets the Intents field's value. -func (s *GetIntentsOutput) SetIntents(v []*IntentMetadata) *GetIntentsOutput { - s.Intents = v +// SetMigrationSummaries sets the MigrationSummaries field's value. +func (s *GetMigrationsOutput) SetMigrationSummaries(v []*MigrationSummary) *GetMigrationsOutput { + s.MigrationSummaries = v return s } // SetNextToken sets the NextToken field's value. -func (s *GetIntentsOutput) SetNextToken(v string) *GetIntentsOutput { +func (s *GetMigrationsOutput) SetNextToken(v string) *GetMigrationsOutput { s.NextToken = &v return s } @@ -9859,6 +10539,165 @@ func (s *Message) SetGroupNumber(v int64) *Message { return s } +// Provides information about alerts and warnings that Amazon Lex sends during +// a migration. The alerts include information about how to resolve the issue. +type MigrationAlert struct { + _ struct{} `type:"structure"` + + // Additional details about the alert. + Details []*string `locationName:"details" type:"list"` + + // A message that describes why the alert was issued. + Message *string `locationName:"message" type:"string"` + + // A link to the Amazon Lex documentation that describes how to resolve the + // alert. + ReferenceURLs []*string `locationName:"referenceURLs" type:"list"` + + // The type of alert. There are two kinds of alerts: + // + // * ERROR - There was an issue with the migration that can't be resolved. + // The migration stops. + // + // * WARN - There was an issue with the migration that requires manual changes + // to the new Amazon Lex V2 bot. The migration continues. + Type *string `locationName:"type" type:"string" enum:"MigrationAlertType"` +} + +// String returns the string representation +func (s MigrationAlert) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s MigrationAlert) GoString() string { + return s.String() +} + +// SetDetails sets the Details field's value. +func (s *MigrationAlert) SetDetails(v []*string) *MigrationAlert { + s.Details = v + return s +} + +// SetMessage sets the Message field's value. +func (s *MigrationAlert) SetMessage(v string) *MigrationAlert { + s.Message = &v + return s +} + +// SetReferenceURLs sets the ReferenceURLs field's value. +func (s *MigrationAlert) SetReferenceURLs(v []*string) *MigrationAlert { + s.ReferenceURLs = v + return s +} + +// SetType sets the Type field's value. +func (s *MigrationAlert) SetType(v string) *MigrationAlert { + s.Type = &v + return s +} + +// Provides information about migrating a bot from Amazon Lex V1 to Amazon Lex +// V2. +type MigrationSummary struct { + _ struct{} `type:"structure"` + + // The unique identifier that Amazon Lex assigned to the migration. + MigrationId *string `locationName:"migrationId" min:"10" type:"string"` + + // The status of the operation. When the status is COMPLETE the bot is available + // in Amazon Lex V2. There may be alerts and warnings that need to be resolved + // to complete the migration. + MigrationStatus *string `locationName:"migrationStatus" type:"string" enum:"MigrationStatus"` + + // The strategy used to conduct the migration. + MigrationStrategy *string `locationName:"migrationStrategy" type:"string" enum:"MigrationStrategy"` + + // The date and time that the migration started. + MigrationTimestamp *time.Time `locationName:"migrationTimestamp" type:"timestamp"` + + // The locale of the Amazon Lex V1 bot that is the source of the migration. + V1BotLocale *string `locationName:"v1BotLocale" type:"string" enum:"Locale"` + + // The name of the Amazon Lex V1 bot that is the source of the migration. + V1BotName *string `locationName:"v1BotName" min:"2" type:"string"` + + // The version of the Amazon Lex V1 bot that is the source of the migration. + V1BotVersion *string `locationName:"v1BotVersion" min:"1" type:"string"` + + // The unique identifier of the Amazon Lex V2 that is the destination of the + // migration. + V2BotId *string `locationName:"v2BotId" min:"10" type:"string"` + + // The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot. + V2BotRole *string `locationName:"v2BotRole" min:"20" type:"string"` +} + +// String returns the string representation +func (s MigrationSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s MigrationSummary) GoString() string { + return s.String() +} + +// SetMigrationId sets the MigrationId field's value. +func (s *MigrationSummary) SetMigrationId(v string) *MigrationSummary { + s.MigrationId = &v + return s +} + +// SetMigrationStatus sets the MigrationStatus field's value. +func (s *MigrationSummary) SetMigrationStatus(v string) *MigrationSummary { + s.MigrationStatus = &v + return s +} + +// SetMigrationStrategy sets the MigrationStrategy field's value. +func (s *MigrationSummary) SetMigrationStrategy(v string) *MigrationSummary { + s.MigrationStrategy = &v + return s +} + +// SetMigrationTimestamp sets the MigrationTimestamp field's value. +func (s *MigrationSummary) SetMigrationTimestamp(v time.Time) *MigrationSummary { + s.MigrationTimestamp = &v + return s +} + +// SetV1BotLocale sets the V1BotLocale field's value. +func (s *MigrationSummary) SetV1BotLocale(v string) *MigrationSummary { + s.V1BotLocale = &v + return s +} + +// SetV1BotName sets the V1BotName field's value. +func (s *MigrationSummary) SetV1BotName(v string) *MigrationSummary { + s.V1BotName = &v + return s +} + +// SetV1BotVersion sets the V1BotVersion field's value. +func (s *MigrationSummary) SetV1BotVersion(v string) *MigrationSummary { + s.V1BotVersion = &v + return s +} + +// SetV2BotId sets the V2BotId field's value. +func (s *MigrationSummary) SetV2BotId(v string) *MigrationSummary { + s.V2BotId = &v + return s +} + +// SetV2BotRole sets the V2BotRole field's value. +func (s *MigrationSummary) SetV2BotRole(v string) *MigrationSummary { + s.V2BotRole = &v + return s +} + // The resource specified in the request was not found. Check the resource and // try again. type NotFoundException struct { @@ -12545,6 +13384,214 @@ func (s *StartImportOutput) SetTags(v []*Tag) *StartImportOutput { return s } +type StartMigrationInput struct { + _ struct{} `type:"structure"` + + // The strategy used to conduct the migration. + // + // * CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon + // Lex V1 bot to the new bot. + // + // * UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata + // and the locale being migrated. It doesn't change any other locales in + // the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created + // in the Amazon Lex V2 bot. + // + // MigrationStrategy is a required field + MigrationStrategy *string `locationName:"migrationStrategy" type:"string" required:"true" enum:"MigrationStrategy"` + + // The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2. + // + // V1BotName is a required field + V1BotName *string `locationName:"v1BotName" min:"2" type:"string" required:"true"` + + // The version of the bot to migrate to Amazon Lex V2. You can migrate the $LATEST + // version as well as any numbered version. + // + // V1BotVersion is a required field + V1BotVersion *string `locationName:"v1BotVersion" min:"1" type:"string" required:"true"` + + // The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 + // bot to. + // + // * If the Amazon Lex V2 bot doesn't exist, you must use the CREATE_NEW + // migration strategy. + // + // * If the Amazon Lex V2 bot exists, you must use the UPDATE_EXISTING migration + // strategy to change the contents of the Amazon Lex V2 bot. + // + // V2BotName is a required field + V2BotName *string `locationName:"v2BotName" min:"1" type:"string" required:"true"` + + // The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot. + // + // V2BotRole is a required field + V2BotRole *string `locationName:"v2BotRole" min:"20" type:"string" required:"true"` +} + +// String returns the string representation +func (s StartMigrationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartMigrationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartMigrationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartMigrationInput"} + if s.MigrationStrategy == nil { + invalidParams.Add(request.NewErrParamRequired("MigrationStrategy")) + } + if s.V1BotName == nil { + invalidParams.Add(request.NewErrParamRequired("V1BotName")) + } + if s.V1BotName != nil && len(*s.V1BotName) < 2 { + invalidParams.Add(request.NewErrParamMinLen("V1BotName", 2)) + } + if s.V1BotVersion == nil { + invalidParams.Add(request.NewErrParamRequired("V1BotVersion")) + } + if s.V1BotVersion != nil && len(*s.V1BotVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("V1BotVersion", 1)) + } + if s.V2BotName == nil { + invalidParams.Add(request.NewErrParamRequired("V2BotName")) + } + if s.V2BotName != nil && len(*s.V2BotName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("V2BotName", 1)) + } + if s.V2BotRole == nil { + invalidParams.Add(request.NewErrParamRequired("V2BotRole")) + } + if s.V2BotRole != nil && len(*s.V2BotRole) < 20 { + invalidParams.Add(request.NewErrParamMinLen("V2BotRole", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMigrationStrategy sets the MigrationStrategy field's value. +func (s *StartMigrationInput) SetMigrationStrategy(v string) *StartMigrationInput { + s.MigrationStrategy = &v + return s +} + +// SetV1BotName sets the V1BotName field's value. +func (s *StartMigrationInput) SetV1BotName(v string) *StartMigrationInput { + s.V1BotName = &v + return s +} + +// SetV1BotVersion sets the V1BotVersion field's value. +func (s *StartMigrationInput) SetV1BotVersion(v string) *StartMigrationInput { + s.V1BotVersion = &v + return s +} + +// SetV2BotName sets the V2BotName field's value. +func (s *StartMigrationInput) SetV2BotName(v string) *StartMigrationInput { + s.V2BotName = &v + return s +} + +// SetV2BotRole sets the V2BotRole field's value. +func (s *StartMigrationInput) SetV2BotRole(v string) *StartMigrationInput { + s.V2BotRole = &v + return s +} + +type StartMigrationOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier that Amazon Lex assigned to the migration. + MigrationId *string `locationName:"migrationId" min:"10" type:"string"` + + // The strategy used to conduct the migration. + MigrationStrategy *string `locationName:"migrationStrategy" type:"string" enum:"MigrationStrategy"` + + // The date and time that the migration started. + MigrationTimestamp *time.Time `locationName:"migrationTimestamp" type:"timestamp"` + + // The locale used for the Amazon Lex V1 bot. + V1BotLocale *string `locationName:"v1BotLocale" type:"string" enum:"Locale"` + + // The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2. + V1BotName *string `locationName:"v1BotName" min:"2" type:"string"` + + // The version of the bot to migrate to Amazon Lex V2. + V1BotVersion *string `locationName:"v1BotVersion" min:"1" type:"string"` + + // The unique identifier for the Amazon Lex V2 bot. + V2BotId *string `locationName:"v2BotId" min:"10" type:"string"` + + // The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot. + V2BotRole *string `locationName:"v2BotRole" min:"20" type:"string"` +} + +// String returns the string representation +func (s StartMigrationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartMigrationOutput) GoString() string { + return s.String() +} + +// SetMigrationId sets the MigrationId field's value. +func (s *StartMigrationOutput) SetMigrationId(v string) *StartMigrationOutput { + s.MigrationId = &v + return s +} + +// SetMigrationStrategy sets the MigrationStrategy field's value. +func (s *StartMigrationOutput) SetMigrationStrategy(v string) *StartMigrationOutput { + s.MigrationStrategy = &v + return s +} + +// SetMigrationTimestamp sets the MigrationTimestamp field's value. +func (s *StartMigrationOutput) SetMigrationTimestamp(v time.Time) *StartMigrationOutput { + s.MigrationTimestamp = &v + return s +} + +// SetV1BotLocale sets the V1BotLocale field's value. +func (s *StartMigrationOutput) SetV1BotLocale(v string) *StartMigrationOutput { + s.V1BotLocale = &v + return s +} + +// SetV1BotName sets the V1BotName field's value. +func (s *StartMigrationOutput) SetV1BotName(v string) *StartMigrationOutput { + s.V1BotName = &v + return s +} + +// SetV1BotVersion sets the V1BotVersion field's value. +func (s *StartMigrationOutput) SetV1BotVersion(v string) *StartMigrationOutput { + s.V1BotVersion = &v + return s +} + +// SetV2BotId sets the V2BotId field's value. +func (s *StartMigrationOutput) SetV2BotId(v string) *StartMigrationOutput { + s.V2BotId = &v + return s +} + +// SetV2BotRole sets the V2BotRole field's value. +func (s *StartMigrationOutput) SetV2BotRole(v string) *StartMigrationOutput { + s.V2BotRole = &v + return s +} + // A collection of messages that convey information to the user. At runtime, // Amazon Lex selects the message to convey. type Statement struct { @@ -13154,6 +14201,74 @@ func MergeStrategy_Values() []string { } } +const ( + // MigrationAlertTypeError is a MigrationAlertType enum value + MigrationAlertTypeError = "ERROR" + + // MigrationAlertTypeWarn is a MigrationAlertType enum value + MigrationAlertTypeWarn = "WARN" +) + +// MigrationAlertType_Values returns all elements of the MigrationAlertType enum +func MigrationAlertType_Values() []string { + return []string{ + MigrationAlertTypeError, + MigrationAlertTypeWarn, + } +} + +const ( + // MigrationSortAttributeV1BotName is a MigrationSortAttribute enum value + MigrationSortAttributeV1BotName = "V1_BOT_NAME" + + // MigrationSortAttributeMigrationDateTime is a MigrationSortAttribute enum value + MigrationSortAttributeMigrationDateTime = "MIGRATION_DATE_TIME" +) + +// MigrationSortAttribute_Values returns all elements of the MigrationSortAttribute enum +func MigrationSortAttribute_Values() []string { + return []string{ + MigrationSortAttributeV1BotName, + MigrationSortAttributeMigrationDateTime, + } +} + +const ( + // MigrationStatusInProgress is a MigrationStatus enum value + MigrationStatusInProgress = "IN_PROGRESS" + + // MigrationStatusCompleted is a MigrationStatus enum value + MigrationStatusCompleted = "COMPLETED" + + // MigrationStatusFailed is a MigrationStatus enum value + MigrationStatusFailed = "FAILED" +) + +// MigrationStatus_Values returns all elements of the MigrationStatus enum +func MigrationStatus_Values() []string { + return []string{ + MigrationStatusInProgress, + MigrationStatusCompleted, + MigrationStatusFailed, + } +} + +const ( + // MigrationStrategyCreateNew is a MigrationStrategy enum value + MigrationStrategyCreateNew = "CREATE_NEW" + + // MigrationStrategyUpdateExisting is a MigrationStrategy enum value + MigrationStrategyUpdateExisting = "UPDATE_EXISTING" +) + +// MigrationStrategy_Values returns all elements of the MigrationStrategy enum +func MigrationStrategy_Values() []string { + return []string{ + MigrationStrategyCreateNew, + MigrationStrategyUpdateExisting, + } +} + const ( // ObfuscationSettingNone is a ObfuscationSetting enum value ObfuscationSettingNone = "NONE" @@ -13262,6 +14377,22 @@ func SlotValueSelectionStrategy_Values() []string { } } +const ( + // SortOrderAscending is a SortOrder enum value + SortOrderAscending = "ASCENDING" + + // SortOrderDescending is a SortOrder enum value + SortOrderDescending = "DESCENDING" +) + +// SortOrder_Values returns all elements of the SortOrder enum +func SortOrder_Values() []string { + return []string{ + SortOrderAscending, + SortOrderDescending, + } +} + const ( // StatusBuilding is a Status enum value StatusBuilding = "BUILDING" diff --git a/service/lexmodelbuildingservice/errors.go b/service/lexmodelbuildingservice/errors.go index ad9e017f214..8f8ebd65374 100644 --- a/service/lexmodelbuildingservice/errors.go +++ b/service/lexmodelbuildingservice/errors.go @@ -8,6 +8,13 @@ import ( const ( + // ErrCodeAccessDeniedException for service response error code + // "AccessDeniedException". + // + // Your IAM user or role does not have permission to call the Amazon Lex V2 + // APIs required to migrate your bot. + ErrCodeAccessDeniedException = "AccessDeniedException" + // ErrCodeBadRequestException for service response error code // "BadRequestException". // @@ -65,6 +72,7 @@ const ( ) var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "AccessDeniedException": newErrorAccessDeniedException, "BadRequestException": newErrorBadRequestException, "ConflictException": newErrorConflictException, "InternalFailureException": newErrorInternalFailureException, diff --git a/service/lexmodelbuildingservice/lexmodelbuildingserviceiface/interface.go b/service/lexmodelbuildingservice/lexmodelbuildingserviceiface/interface.go index 62277f0ebb7..e33fb71e1d3 100644 --- a/service/lexmodelbuildingservice/lexmodelbuildingserviceiface/interface.go +++ b/service/lexmodelbuildingservice/lexmodelbuildingserviceiface/interface.go @@ -192,6 +192,17 @@ type LexModelBuildingServiceAPI interface { GetIntentsPages(*lexmodelbuildingservice.GetIntentsInput, func(*lexmodelbuildingservice.GetIntentsOutput, bool) bool) error GetIntentsPagesWithContext(aws.Context, *lexmodelbuildingservice.GetIntentsInput, func(*lexmodelbuildingservice.GetIntentsOutput, bool) bool, ...request.Option) error + GetMigration(*lexmodelbuildingservice.GetMigrationInput) (*lexmodelbuildingservice.GetMigrationOutput, error) + GetMigrationWithContext(aws.Context, *lexmodelbuildingservice.GetMigrationInput, ...request.Option) (*lexmodelbuildingservice.GetMigrationOutput, error) + GetMigrationRequest(*lexmodelbuildingservice.GetMigrationInput) (*request.Request, *lexmodelbuildingservice.GetMigrationOutput) + + GetMigrations(*lexmodelbuildingservice.GetMigrationsInput) (*lexmodelbuildingservice.GetMigrationsOutput, error) + GetMigrationsWithContext(aws.Context, *lexmodelbuildingservice.GetMigrationsInput, ...request.Option) (*lexmodelbuildingservice.GetMigrationsOutput, error) + GetMigrationsRequest(*lexmodelbuildingservice.GetMigrationsInput) (*request.Request, *lexmodelbuildingservice.GetMigrationsOutput) + + GetMigrationsPages(*lexmodelbuildingservice.GetMigrationsInput, func(*lexmodelbuildingservice.GetMigrationsOutput, bool) bool) error + GetMigrationsPagesWithContext(aws.Context, *lexmodelbuildingservice.GetMigrationsInput, func(*lexmodelbuildingservice.GetMigrationsOutput, bool) bool, ...request.Option) error + GetSlotType(*lexmodelbuildingservice.GetSlotTypeInput) (*lexmodelbuildingservice.GetSlotTypeOutput, error) GetSlotTypeWithContext(aws.Context, *lexmodelbuildingservice.GetSlotTypeInput, ...request.Option) (*lexmodelbuildingservice.GetSlotTypeOutput, error) GetSlotTypeRequest(*lexmodelbuildingservice.GetSlotTypeInput) (*request.Request, *lexmodelbuildingservice.GetSlotTypeOutput) @@ -238,6 +249,10 @@ type LexModelBuildingServiceAPI interface { StartImportWithContext(aws.Context, *lexmodelbuildingservice.StartImportInput, ...request.Option) (*lexmodelbuildingservice.StartImportOutput, error) StartImportRequest(*lexmodelbuildingservice.StartImportInput) (*request.Request, *lexmodelbuildingservice.StartImportOutput) + StartMigration(*lexmodelbuildingservice.StartMigrationInput) (*lexmodelbuildingservice.StartMigrationOutput, error) + StartMigrationWithContext(aws.Context, *lexmodelbuildingservice.StartMigrationInput, ...request.Option) (*lexmodelbuildingservice.StartMigrationOutput, error) + StartMigrationRequest(*lexmodelbuildingservice.StartMigrationInput) (*request.Request, *lexmodelbuildingservice.StartMigrationOutput) + TagResource(*lexmodelbuildingservice.TagResourceInput) (*lexmodelbuildingservice.TagResourceOutput, error) TagResourceWithContext(aws.Context, *lexmodelbuildingservice.TagResourceInput, ...request.Option) (*lexmodelbuildingservice.TagResourceOutput, error) TagResourceRequest(*lexmodelbuildingservice.TagResourceInput) (*request.Request, *lexmodelbuildingservice.TagResourceOutput) diff --git a/service/pricing/api.go b/service/pricing/api.go index 79be646104b..effcb965dcf 100644 --- a/service/pricing/api.go +++ b/service/pricing/api.go @@ -219,7 +219,7 @@ func (c *Pricing) GetAttributeValuesRequest(input *GetAttributeValuesInput) (req // Returns a list of attribute values. Attibutes are similar to the details // in a Price List API offer file. For a list of available attributes, see Offer // File Definitions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs) -// in the AWS Billing and Cost Management User Guide (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html). +// in the Amazon Web Services Billing and Cost Management User Guide (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1211,7 +1211,7 @@ type Service struct { // The attributes that are available for this service. AttributeNames []*string `type:"list"` - // The code for the AWS service. + // The code for the Amazon Web Services service. ServiceCode *string `type:"string"` } diff --git a/service/pricing/doc.go b/service/pricing/doc.go index 50e997ecdd6..076ea5c7f62 100644 --- a/service/pricing/doc.go +++ b/service/pricing/doc.go @@ -3,14 +3,15 @@ // Package pricing provides the client and types for making API // requests to AWS Price List Service. // -// AWS Price List Service API (AWS Price List Service) is a centralized and -// convenient way to programmatically query Amazon Web Services for services, -// products, and pricing information. The AWS Price List Service uses standardized -// product attributes such as Location, Storage Class, and Operating System, -// and provides prices at the SKU level. You can use the AWS Price List Service -// to build cost control and scenario planning tools, reconcile billing data, -// forecast future spend for budgeting purposes, and provide cost benefit analysis -// that compare your internal workloads with AWS. +// Amazon Web Services Price List Service API (Amazon Web Services Price List +// Service) is a centralized and convenient way to programmatically query Amazon +// Web Services for services, products, and pricing information. The Amazon +// Web Services Price List Service uses standardized product attributes such +// as Location, Storage Class, and Operating System, and provides prices at +// the SKU level. You can use the Amazon Web Services Price List Service to +// build cost control and scenario planning tools, reconcile billing data, forecast +// future spend for budgeting purposes, and provide cost benefit analysis that +// compare your internal workloads with Amazon Web Services. // // Use GetServices without a service code to retrieve the service codes for // all AWS services, then GetServices with a service code to retreive the attribute @@ -22,7 +23,7 @@ // // Service Endpoint // -// AWS Price List Service API provides the following two endpoints: +// Amazon Web Services Price List Service API provides the following two endpoints: // // * https://api.pricing.us-east-1.amazonaws.com // diff --git a/service/pricing/examples_test.go b/service/pricing/examples_test.go index 30bcc5c0fb4..379aed68da8 100644 --- a/service/pricing/examples_test.go +++ b/service/pricing/examples_test.go @@ -102,53 +102,3 @@ func ExamplePricing_GetAttributeValues_shared00() { fmt.Println(result) } - -// To retrieve a list of products -// -// This operation returns a list of products that match the given criteria. -func ExamplePricing_GetProducts_shared00() { - svc := pricing.New(session.New()) - input := &pricing.GetProductsInput{ - Filters: []*pricing.Filter{ - { - Field: aws.String("ServiceCode"), - Type: aws.String("TERM_MATCH"), - Value: aws.String("AmazonEC2"), - }, - { - Field: aws.String("volumeType"), - Type: aws.String("TERM_MATCH"), - Value: aws.String("Provisioned IOPS"), - }, - }, - FormatVersion: aws.String("aws_v1"), - MaxResults: aws.Int64(1), - } - - result, err := svc.GetProducts(input) - if err != nil { - if aerr, ok := err.(awserr.Error); ok { - switch aerr.Code() { - case pricing.ErrCodeInternalErrorException: - fmt.Println(pricing.ErrCodeInternalErrorException, aerr.Error()) - case pricing.ErrCodeInvalidParameterException: - fmt.Println(pricing.ErrCodeInvalidParameterException, aerr.Error()) - case pricing.ErrCodeNotFoundException: - fmt.Println(pricing.ErrCodeNotFoundException, aerr.Error()) - case pricing.ErrCodeInvalidNextTokenException: - fmt.Println(pricing.ErrCodeInvalidNextTokenException, aerr.Error()) - case pricing.ErrCodeExpiredNextTokenException: - fmt.Println(pricing.ErrCodeExpiredNextTokenException, aerr.Error()) - default: - fmt.Println(aerr.Error()) - } - } else { - // Print the error, cast err to awserr.Error to get the Code and - // Message from an error. - fmt.Println(err.Error()) - } - return - } - - fmt.Println(result) -} diff --git a/service/redshift/api.go b/service/redshift/api.go index 94506c28353..21e7c3a95fe 100644 --- a/service/redshift/api.go +++ b/service/redshift/api.go @@ -253,7 +253,7 @@ func (c *Redshift) AuthorizeClusterSecurityGroupIngressRequest(input *AuthorizeC // // If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName // and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift -// cluster must be in the same AWS Region. +// cluster must be in the same Region. // // If you authorize access to a CIDR/IP address range, specify CIDRIP. For an // overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain @@ -447,7 +447,7 @@ func (c *Redshift) AuthorizeSnapshotAccessRequest(input *AuthorizeSnapshotAccess // AuthorizeSnapshotAccess API operation for Amazon Redshift. // -// Authorizes the specified AWS customer account to restore the specified snapshot. +// Authorizes the specified account to restore the specified snapshot. // // For more information about working with snapshots, go to Amazon Redshift // Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) @@ -480,7 +480,7 @@ func (c *Redshift) AuthorizeSnapshotAccessRequest(input *AuthorizeSnapshotAccess // are authorized to access the snapshot. // // * ErrCodeLimitExceededFault "LimitExceededFault" -// The encryption key has exceeded its grant limit in AWS KMS. +// The encryption key has exceeded its grant limit in Amazon Web Services KMS. // // See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizeSnapshotAccess func (c *Redshift) AuthorizeSnapshotAccess(input *AuthorizeSnapshotAccessInput) (*AuthorizeSnapshotAccessOutput, error) { @@ -865,6 +865,95 @@ func (c *Redshift) CopyClusterSnapshotWithContext(ctx aws.Context, input *CopyCl return out, req.Send() } +const opCreateAuthenticationProfile = "CreateAuthenticationProfile" + +// CreateAuthenticationProfileRequest generates a "aws/request.Request" representing the +// client's request for the CreateAuthenticationProfile operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateAuthenticationProfile for more information on using the CreateAuthenticationProfile +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateAuthenticationProfileRequest method. +// req, resp := client.CreateAuthenticationProfileRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateAuthenticationProfile +func (c *Redshift) CreateAuthenticationProfileRequest(input *CreateAuthenticationProfileInput) (req *request.Request, output *CreateAuthenticationProfileOutput) { + op := &request.Operation{ + Name: opCreateAuthenticationProfile, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateAuthenticationProfileInput{} + } + + output = &CreateAuthenticationProfileOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateAuthenticationProfile API operation for Amazon Redshift. +// +// Creates an authentication profile with the specified parameters. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Redshift's +// API operation CreateAuthenticationProfile for usage and error information. +// +// Returned Error Codes: +// * ErrCodeAuthenticationProfileAlreadyExistsFault "AuthenticationProfileAlreadyExistsFault" +// The authentication profile already exists. +// +// * ErrCodeAuthenticationProfileQuotaExceededFault "AuthenticationProfileQuotaExceededFault" +// The size or number of authentication profiles has exceeded the quota. The +// maximum length of the JSON string and maximum number of authentication profiles +// is determined by a quota for your account. +// +// * ErrCodeInvalidAuthenticationProfileRequestFault "InvalidAuthenticationProfileRequestFault" +// The authentication profile request is not valid. The profile name can't be +// null or empty. The authentication profile API operation must be available +// in the Region. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateAuthenticationProfile +func (c *Redshift) CreateAuthenticationProfile(input *CreateAuthenticationProfileInput) (*CreateAuthenticationProfileOutput, error) { + req, out := c.CreateAuthenticationProfileRequest(input) + return out, req.Send() +} + +// CreateAuthenticationProfileWithContext is the same as CreateAuthenticationProfile with the addition of +// the ability to pass a context and additional request options. +// +// See CreateAuthenticationProfile for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Redshift) CreateAuthenticationProfileWithContext(ctx aws.Context, input *CreateAuthenticationProfileInput, opts ...request.Option) (*CreateAuthenticationProfileOutput, error) { + req, out := c.CreateAuthenticationProfileRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateCluster = "CreateCluster" // CreateClusterRequest generates a "aws/request.Request" representing the @@ -986,7 +1075,7 @@ func (c *Redshift) CreateClusterRequest(input *CreateClusterInput) (req *request // The tag is invalid. // // * ErrCodeLimitExceededFault "LimitExceededFault" -// The encryption key has exceeded its grant limit in AWS KMS. +// The encryption key has exceeded its grant limit in Amazon Web Services KMS. // // * ErrCodeDependentServiceRequestThrottlingFault "DependentServiceRequestThrottlingFault" // The request cannot be completed because a dependent service is throttling @@ -1613,10 +1702,10 @@ func (c *Redshift) CreateEventSubscriptionRequest(input *CreateEventSubscription // cluster and source identifier = my-cluster-1, notifications will be sent // for all the cluster events for my-cluster-1. If you specify a source type // but do not specify a source identifier, you will receive notice of the events -// for the objects of that type in your AWS account. If you do not specify either +// for the objects of that type in your account. If you do not specify either // the SourceType nor the SourceIdentifier, you will be notified of events generated -// from all Amazon Redshift sources belonging to your AWS account. You must -// specify a source type if you specify a source ID. +// from all Amazon Redshift sources belonging to your account. You must specify +// a source type if you specify a source ID. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2031,8 +2120,8 @@ func (c *Redshift) CreateSnapshotCopyGrantRequest(input *CreateSnapshotCopyGrant // CreateSnapshotCopyGrant API operation for Amazon Redshift. // // Creates a snapshot copy grant that permits Amazon Redshift to use a customer -// master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied -// snapshots in a destination region. +// master key (CMK) from Key Management Service (KMS) to encrypt copied snapshots +// in a destination region. // // For more information about managing snapshot copy grants, go to Amazon Redshift // Database Encryption (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) @@ -2051,11 +2140,11 @@ func (c *Redshift) CreateSnapshotCopyGrantRequest(input *CreateSnapshotCopyGrant // already exists. // // * ErrCodeSnapshotCopyGrantQuotaExceededFault "SnapshotCopyGrantQuotaExceededFault" -// The AWS account has exceeded the maximum number of snapshot copy grants in -// this region. +// The account has exceeded the maximum number of snapshot copy grants in this +// region. // // * ErrCodeLimitExceededFault "LimitExceededFault" -// The encryption key has exceeded its grant limit in AWS KMS. +// The encryption key has exceeded its grant limit in Amazon Web Services KMS. // // * ErrCodeTagLimitExceededFault "TagLimitExceededFault" // You have exceeded the number of tags allowed. @@ -2341,7 +2430,7 @@ func (c *Redshift) CreateUsageLimitRequest(input *CreateUsageLimitInput) (req *r // The specified cluster is not in the available state. // // * ErrCodeLimitExceededFault "LimitExceededFault" -// The encryption key has exceeded its grant limit in AWS KMS. +// The encryption key has exceeded its grant limit in Amazon Web Services KMS. // // * ErrCodeUsageLimitAlreadyExistsFault "UsageLimitAlreadyExists" // The usage limit already exists. @@ -2377,6 +2466,90 @@ func (c *Redshift) CreateUsageLimitWithContext(ctx aws.Context, input *CreateUsa return out, req.Send() } +const opDeleteAuthenticationProfile = "DeleteAuthenticationProfile" + +// DeleteAuthenticationProfileRequest generates a "aws/request.Request" representing the +// client's request for the DeleteAuthenticationProfile operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteAuthenticationProfile for more information on using the DeleteAuthenticationProfile +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteAuthenticationProfileRequest method. +// req, resp := client.DeleteAuthenticationProfileRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteAuthenticationProfile +func (c *Redshift) DeleteAuthenticationProfileRequest(input *DeleteAuthenticationProfileInput) (req *request.Request, output *DeleteAuthenticationProfileOutput) { + op := &request.Operation{ + Name: opDeleteAuthenticationProfile, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteAuthenticationProfileInput{} + } + + output = &DeleteAuthenticationProfileOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteAuthenticationProfile API operation for Amazon Redshift. +// +// Deletes an authentication profile. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Redshift's +// API operation DeleteAuthenticationProfile for usage and error information. +// +// Returned Error Codes: +// * ErrCodeAuthenticationProfileNotFoundFault "AuthenticationProfileNotFoundFault" +// The authentication profile can't be found. +// +// * ErrCodeInvalidAuthenticationProfileRequestFault "InvalidAuthenticationProfileRequestFault" +// The authentication profile request is not valid. The profile name can't be +// null or empty. The authentication profile API operation must be available +// in the Region. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteAuthenticationProfile +func (c *Redshift) DeleteAuthenticationProfile(input *DeleteAuthenticationProfileInput) (*DeleteAuthenticationProfileOutput, error) { + req, out := c.DeleteAuthenticationProfileRequest(input) + return out, req.Send() +} + +// DeleteAuthenticationProfileWithContext is the same as DeleteAuthenticationProfile with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteAuthenticationProfile for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Redshift) DeleteAuthenticationProfileWithContext(ctx aws.Context, input *DeleteAuthenticationProfileInput, opts ...request.Option) (*DeleteAuthenticationProfileOutput, error) { + req, out := c.DeleteAuthenticationProfileRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteCluster = "DeleteCluster" // DeleteClusterRequest generates a "aws/request.Request" representing the @@ -3766,6 +3939,90 @@ func (c *Redshift) DescribeAccountAttributesWithContext(ctx aws.Context, input * return out, req.Send() } +const opDescribeAuthenticationProfiles = "DescribeAuthenticationProfiles" + +// DescribeAuthenticationProfilesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeAuthenticationProfiles operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeAuthenticationProfiles for more information on using the DescribeAuthenticationProfiles +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeAuthenticationProfilesRequest method. +// req, resp := client.DescribeAuthenticationProfilesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeAuthenticationProfiles +func (c *Redshift) DescribeAuthenticationProfilesRequest(input *DescribeAuthenticationProfilesInput) (req *request.Request, output *DescribeAuthenticationProfilesOutput) { + op := &request.Operation{ + Name: opDescribeAuthenticationProfiles, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeAuthenticationProfilesInput{} + } + + output = &DescribeAuthenticationProfilesOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeAuthenticationProfiles API operation for Amazon Redshift. +// +// Describes an authentication profile. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Redshift's +// API operation DescribeAuthenticationProfiles for usage and error information. +// +// Returned Error Codes: +// * ErrCodeAuthenticationProfileNotFoundFault "AuthenticationProfileNotFoundFault" +// The authentication profile can't be found. +// +// * ErrCodeInvalidAuthenticationProfileRequestFault "InvalidAuthenticationProfileRequestFault" +// The authentication profile request is not valid. The profile name can't be +// null or empty. The authentication profile API operation must be available +// in the Region. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeAuthenticationProfiles +func (c *Redshift) DescribeAuthenticationProfiles(input *DescribeAuthenticationProfilesInput) (*DescribeAuthenticationProfilesOutput, error) { + req, out := c.DescribeAuthenticationProfilesRequest(input) + return out, req.Send() +} + +// DescribeAuthenticationProfilesWithContext is the same as DescribeAuthenticationProfiles with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeAuthenticationProfiles for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Redshift) DescribeAuthenticationProfilesWithContext(ctx aws.Context, input *DescribeAuthenticationProfilesInput, opts ...request.Option) (*DescribeAuthenticationProfilesOutput, error) { + req, out := c.DescribeAuthenticationProfilesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeClusterDbRevisions = "DescribeClusterDbRevisions" // DescribeClusterDbRevisionsRequest generates a "aws/request.Request" representing the @@ -4421,8 +4678,8 @@ func (c *Redshift) DescribeClusterSnapshotsRequest(input *DescribeClusterSnapsho // // Returns one or more snapshot objects, which contain metadata about your cluster // snapshots. By default, this operation returns information about all snapshots -// of all clusters that are owned by you AWS customer account. No information -// is returned for snapshots owned by inactive AWS customer accounts. +// of all clusters that are owned by your account. No information is returned +// for snapshots owned by inactive accounts. // // If you specify both tag keys and tag values in the same request, Amazon Redshift // returns all snapshots that match any combination of the specified keys and @@ -4578,7 +4835,7 @@ func (c *Redshift) DescribeClusterSubnetGroupsRequest(input *DescribeClusterSubn // // Returns one or more cluster subnet group objects, which contain metadata // about your cluster subnet groups. By default, this operation returns information -// about all cluster subnet groups that are defined in you AWS account. +// about all cluster subnet groups that are defined in your account. // // If you specify both tag keys and tag values in the same request, Amazon Redshift // returns all subnet groups that match any combination of the specified keys @@ -5943,7 +6200,7 @@ func (c *Redshift) DescribeHsmClientCertificatesRequest(input *DescribeHsmClient // // Returns information about the specified HSM client certificate. If no certificate // ID is specified, returns information about all the HSM certificates owned -// by your AWS customer account. +// by your account. // // If you specify both tag keys and tag values in the same request, Amazon Redshift // returns all HSM client certificates that match any combination of the specified @@ -6095,7 +6352,7 @@ func (c *Redshift) DescribeHsmConfigurationsRequest(input *DescribeHsmConfigurat // // Returns information about the specified Amazon Redshift HSM configuration. // If no configuration ID is specified, returns information about all the HSM -// configurations owned by your AWS customer account. +// configurations owned by your account. // // If you specify both tag keys and tag values in the same request, Amazon Redshift // returns all HSM connections that match any combination of the specified keys @@ -6476,7 +6733,7 @@ func (c *Redshift) DescribeOrderableClusterOptionsRequest(input *DescribeOrderab // // Returns a list of orderable cluster options. Before you create a new cluster // you can use this operation to find what options are available, such as the -// EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, +// EC2 Availability Zones (AZ) in the specific Region that you can specify, // and the node types you can request. The node types differ by available storage, // memory, CPU and price. With the cost involved you might want to obtain a // list of cluster options in the specific region and specify values when creating @@ -7218,7 +7475,7 @@ func (c *Redshift) DescribeSnapshotCopyGrantsRequest(input *DescribeSnapshotCopy // DescribeSnapshotCopyGrants API operation for Amazon Redshift. // -// Returns a list of snapshot copy grants owned by the AWS account in the destination +// Returns a list of snapshot copy grants owned by the account in the destination // region. // // For more information about managing snapshot copy grants, go to Amazon Redshift @@ -8111,8 +8368,9 @@ func (c *Redshift) DisableSnapshotCopyRequest(input *DisableSnapshotCopyInput) ( // for a specified cluster. // // If your cluster and its snapshots are encrypted using a customer master key -// (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that -// grants Amazon Redshift permission to the CMK in the destination region. +// (CMK) from Key Management Service, use DeleteSnapshotCopyGrant to delete +// the grant that grants Amazon Redshift permission to the CMK in the destination +// region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8336,7 +8594,7 @@ func (c *Redshift) EnableSnapshotCopyRequest(input *EnableSnapshotCopyInput) (re // is typed correctly and that the grant exists in the destination region. // // * ErrCodeLimitExceededFault "LimitExceededFault" -// The encryption key has exceeded its grant limit in AWS KMS. +// The encryption key has exceeded its grant limit in Amazon Web Services KMS. // // * ErrCodeDependentServiceRequestThrottlingFault "DependentServiceRequestThrottlingFault" // The request cannot be completed because a dependent service is throttling @@ -8423,7 +8681,7 @@ func (c *Redshift) GetClusterCredentialsRequest(input *GetClusterCredentialsInpu // IAM Authentication to Generate Database User Credentials (https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html) // in the Amazon Redshift Cluster Management Guide. // -// The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials +// The Identity and Access Management (IAM) user or role that runs GetClusterCredentials // must have an IAM policy attached that allows access to all necessary actions // and resources. For more information about permissions, see Resource Policies // for GetClusterCredentials (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources) @@ -8713,6 +8971,95 @@ func (c *Redshift) ModifyAquaConfigurationWithContext(ctx aws.Context, input *Mo return out, req.Send() } +const opModifyAuthenticationProfile = "ModifyAuthenticationProfile" + +// ModifyAuthenticationProfileRequest generates a "aws/request.Request" representing the +// client's request for the ModifyAuthenticationProfile operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ModifyAuthenticationProfile for more information on using the ModifyAuthenticationProfile +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ModifyAuthenticationProfileRequest method. +// req, resp := client.ModifyAuthenticationProfileRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyAuthenticationProfile +func (c *Redshift) ModifyAuthenticationProfileRequest(input *ModifyAuthenticationProfileInput) (req *request.Request, output *ModifyAuthenticationProfileOutput) { + op := &request.Operation{ + Name: opModifyAuthenticationProfile, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ModifyAuthenticationProfileInput{} + } + + output = &ModifyAuthenticationProfileOutput{} + req = c.newRequest(op, input, output) + return +} + +// ModifyAuthenticationProfile API operation for Amazon Redshift. +// +// Modifies an authentication profile. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Redshift's +// API operation ModifyAuthenticationProfile for usage and error information. +// +// Returned Error Codes: +// * ErrCodeAuthenticationProfileNotFoundFault "AuthenticationProfileNotFoundFault" +// The authentication profile can't be found. +// +// * ErrCodeAuthenticationProfileQuotaExceededFault "AuthenticationProfileQuotaExceededFault" +// The size or number of authentication profiles has exceeded the quota. The +// maximum length of the JSON string and maximum number of authentication profiles +// is determined by a quota for your account. +// +// * ErrCodeInvalidAuthenticationProfileRequestFault "InvalidAuthenticationProfileRequestFault" +// The authentication profile request is not valid. The profile name can't be +// null or empty. The authentication profile API operation must be available +// in the Region. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyAuthenticationProfile +func (c *Redshift) ModifyAuthenticationProfile(input *ModifyAuthenticationProfileInput) (*ModifyAuthenticationProfileOutput, error) { + req, out := c.ModifyAuthenticationProfileRequest(input) + return out, req.Send() +} + +// ModifyAuthenticationProfileWithContext is the same as ModifyAuthenticationProfile with the addition of +// the ability to pass a context and additional request options. +// +// See ModifyAuthenticationProfile for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Redshift) ModifyAuthenticationProfileWithContext(ctx aws.Context, input *ModifyAuthenticationProfileInput, opts ...request.Option) (*ModifyAuthenticationProfileOutput, error) { + req, out := c.ModifyAuthenticationProfileRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opModifyCluster = "ModifyCluster" // ModifyClusterRequest generates a "aws/request.Request" representing the @@ -8763,7 +9110,7 @@ func (c *Redshift) ModifyClusterRequest(input *ModifyClusterInput) (req *request // the cluster. When resizing a cluster, you must specify both the number of // nodes and the node type even if one of the parameters does not change. // -// You can add another security or parameter group, or change the master user +// You can add another security or parameter group, or change the admin user // password. Resetting a cluster password or modifying the security groups associated // with a cluster do not need a reboot. However, modifying a parameter group // requires a reboot for parameters to take effect. For more information about @@ -8822,7 +9169,7 @@ func (c *Redshift) ModifyClusterRequest(input *ModifyClusterInput) (req *request // The account already has a cluster with the given identifier. // // * ErrCodeLimitExceededFault "LimitExceededFault" -// The encryption key has exceeded its grant limit in AWS KMS. +// The encryption key has exceeded its grant limit in Amazon Web Services KMS. // // * ErrCodeDependentServiceRequestThrottlingFault "DependentServiceRequestThrottlingFault" // The request cannot be completed because a dependent service is throttling @@ -8995,8 +9342,8 @@ func (c *Redshift) ModifyClusterIamRolesRequest(input *ModifyClusterIamRolesInpu // ModifyClusterIamRoles API operation for Amazon Redshift. // -// Modifies the list of AWS Identity and Access Management (IAM) roles that -// can be used by the cluster to access other AWS services. +// Modifies the list of Identity and Access Management (IAM) roles that can +// be used by the cluster to access other Amazon Web Services services. // // A cluster can have up to 10 IAM roles associated at any time. // @@ -9825,8 +10172,8 @@ func (c *Redshift) ModifySnapshotCopyRetentionPeriodRequest(input *ModifySnapsho // ModifySnapshotCopyRetentionPeriod API operation for Amazon Redshift. // -// Modifies the number of days to retain snapshots in the destination AWS Region -// after they are copied from the source AWS Region. By default, this operation +// Modifies the number of days to retain snapshots in the destination Region +// after they are copied from the source Region. By default, this operation // only changes the retention period of copied automated snapshots. The retention // periods for both new and existing copied automated snapshots are updated // with the new retention period. You can set the manual option to change only @@ -10500,7 +10847,7 @@ func (c *Redshift) ResizeClusterRequest(input *ResizeClusterInput) (req *request // Your account is not authorized to perform the requested operation. // // * ErrCodeLimitExceededFault "LimitExceededFault" -// The encryption key has exceeded its grant limit in AWS KMS. +// The encryption key has exceeded its grant limit in Amazon Web Services KMS. // // See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResizeCluster func (c *Redshift) ResizeCluster(input *ResizeClusterInput) (*ResizeClusterOutput, error) { @@ -10661,7 +11008,7 @@ func (c *Redshift) RestoreFromClusterSnapshotRequest(input *RestoreFromClusterSn // group. // // * ErrCodeLimitExceededFault "LimitExceededFault" -// The encryption key has exceeded its grant limit in AWS KMS. +// The encryption key has exceeded its grant limit in Amazon Web Services KMS. // // * ErrCodeDependentServiceRequestThrottlingFault "DependentServiceRequestThrottlingFault" // The request cannot be completed because a dependent service is throttling @@ -11130,9 +11477,9 @@ func (c *Redshift) RevokeSnapshotAccessRequest(input *RevokeSnapshotAccessInput) // RevokeSnapshotAccess API operation for Amazon Redshift. // -// Removes the ability of the specified AWS customer account to restore the -// specified snapshot. If the account is currently restoring the snapshot, the -// restore will run to completion. +// Removes the ability of the specified account to restore the specified snapshot. +// If the account is currently restoring the snapshot, the restore will run +// to completion. // // For more information about working with snapshots, go to Amazon Redshift // Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) @@ -11461,15 +11808,15 @@ func (s *AccountAttribute) SetAttributeValues(v []*AttributeValueTarget) *Accoun return s } -// Describes an AWS customer account authorized to restore a snapshot. +// Describes an account authorized to restore a snapshot. type AccountWithRestoreAccess struct { _ struct{} `type:"structure"` - // The identifier of an AWS support account authorized to restore a snapshot. - // For AWS support, the identifier is amazon-redshift-support. + // The identifier of an Amazon Web Services support account authorized to restore + // a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support. AccountAlias *string `type:"string"` - // The identifier of an AWS customer account authorized to restore a snapshot. + // The identifier of an account authorized to restore a snapshot. AccountId *string `type:"string"` } @@ -11498,7 +11845,7 @@ func (s *AccountWithRestoreAccess) SetAccountId(v string) *AccountWithRestoreAcc type AddPartnerInput struct { _ struct{} `type:"structure"` - // The AWS account ID that owns the cluster. + // The Region ID that owns the cluster. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` @@ -11617,8 +11964,8 @@ type AquaConfiguration struct { // The value represents how the cluster is configured to use AQUA. Possible // values include the following. // - // * enabled - Use AQUA if it is available for the current AWS Region and - // Amazon Redshift node type. + // * enabled - Use AQUA if it is available for the current Region and Amazon + // Redshift node type. // // * disabled - Don't use AQUA. // @@ -11682,6 +12029,40 @@ func (s *AttributeValueTarget) SetAttributeValue(v string) *AttributeValueTarget return s } +// Describes an authentication profile. +type AuthenticationProfile struct { + _ struct{} `type:"structure"` + + // The content of the authentication profile in JSON format. The maximum length + // of the JSON string is determined by a quota for your account. + AuthenticationProfileContent *string `type:"string"` + + // The name of the authentication profile. + AuthenticationProfileName *string `type:"string"` +} + +// String returns the string representation +func (s AuthenticationProfile) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AuthenticationProfile) GoString() string { + return s.String() +} + +// SetAuthenticationProfileContent sets the AuthenticationProfileContent field's value. +func (s *AuthenticationProfile) SetAuthenticationProfileContent(v string) *AuthenticationProfile { + s.AuthenticationProfileContent = &v + return s +} + +// SetAuthenticationProfileName sets the AuthenticationProfileName field's value. +func (s *AuthenticationProfile) SetAuthenticationProfileName(v string) *AuthenticationProfile { + s.AuthenticationProfileName = &v + return s +} + type AuthorizeClusterSecurityGroupIngressInput struct { _ struct{} `type:"structure"` @@ -11696,9 +12077,8 @@ type AuthorizeClusterSecurityGroupIngressInput struct { // The EC2 security group to be added the Amazon Redshift security group. EC2SecurityGroupName *string `type:"string"` - // The AWS account number of the owner of the security group specified by the - // EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable - // value. + // The account number of the owner of the security group specified by the EC2SecurityGroupName + // parameter. The Amazon Web Services Access Key ID is not an acceptable value. // // Example: 111122223333 EC2SecurityGroupOwnerId *string `type:"string"` @@ -11777,7 +12157,7 @@ func (s *AuthorizeClusterSecurityGroupIngressOutput) SetClusterSecurityGroup(v * type AuthorizeEndpointAccessInput struct { _ struct{} `type:"structure"` - // The AWS account ID to grant access to. + // The account ID to grant access to. // // Account is a required field Account *string `type:"string" required:"true"` @@ -11831,7 +12211,7 @@ func (s *AuthorizeEndpointAccessInput) SetVpcIds(v []*string) *AuthorizeEndpoint } // Describes an endpoint authorization for authorizing Redshift-managed VPC -// endpoint access to a cluster across AWS accounts. +// endpoint access to a cluster across accounts. type AuthorizeEndpointAccessOutput struct { _ struct{} `type:"structure"` @@ -11854,10 +12234,10 @@ type AuthorizeEndpointAccessOutput struct { // The number of Redshift-managed VPC endpoints created for the authorization. EndpointCount *int64 `type:"integer"` - // The AWS account ID of the grantee of the cluster. + // The account ID of the grantee of the cluster. Grantee *string `type:"string"` - // The AWS account ID of the cluster owner. + // The account ID of the cluster owner. Grantor *string `type:"string"` // The status of the authorization action. @@ -11931,10 +12311,9 @@ func (s *AuthorizeEndpointAccessOutput) SetStatus(v string) *AuthorizeEndpointAc type AuthorizeSnapshotAccessInput struct { _ struct{} `type:"structure"` - // The identifier of the AWS customer account authorized to restore the specified - // snapshot. + // The identifier of the account authorized to restore the specified snapshot. // - // To share a snapshot with AWS support, specify amazon-redshift-support. + // To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support. // // AccountWithRestoreAccess is a required field AccountWithRestoreAccess *string `type:"string" required:"true"` @@ -12627,12 +13006,12 @@ type Cluster struct { // Values: active, applying HsmStatus *HsmStatus `type:"structure"` - // A list of AWS Identity and Access Management (IAM) roles that can be used - // by the cluster to access other AWS services. + // A list of Identity and Access Management (IAM) roles that can be used by + // the cluster to access other Amazon Web Services services. IamRoles []*ClusterIamRole `locationNameList:"ClusterIamRole" type:"list"` - // The AWS Key Management Service (AWS KMS) key ID of the encryption key used - // to encrypt data in the cluster. + // The Key Management Service (KMS) key ID of the encryption key used to encrypt + // data in the cluster. KmsKeyId *string `type:"string"` // The name of the maintenance track for the cluster. @@ -12645,7 +13024,7 @@ type Cluster struct { // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int64 `type:"integer"` - // The master user name for the cluster. This name is used to connect to the + // The admin user name for the cluster. This name is used to connect to the // database that is specified in the DBName parameter. MasterUsername *string `type:"string"` @@ -13101,8 +13480,8 @@ func (s *ClusterDbRevision) SetRevisionTargets(v []*RevisionTarget) *ClusterDbRe return s } -// An AWS Identity and Access Management (IAM) role that can be used by the -// associated Amazon Redshift cluster to access other AWS services. +// An Identity and Access Management (IAM) role that can be used by the associated +// Amazon Redshift cluster to access other Amazon Web Services services. type ClusterIamRole struct { _ struct{} `type:"structure"` @@ -13692,7 +14071,7 @@ type CopyClusterSnapshotInput struct { // // * Cannot end with a hyphen or contain two consecutive hyphens. // - // * Must be unique for the AWS account that is making the request. + // * Must be unique for the account that is making the request. // // TargetSnapshotIdentifier is a required field TargetSnapshotIdentifier *string `type:"string" required:"true"` @@ -13771,6 +14150,91 @@ func (s *CopyClusterSnapshotOutput) SetSnapshot(v *Snapshot) *CopyClusterSnapsho return s } +type CreateAuthenticationProfileInput struct { + _ struct{} `type:"structure"` + + // The content of the authentication profile in JSON format. The maximum length + // of the JSON string is determined by a quota for your account. + // + // AuthenticationProfileContent is a required field + AuthenticationProfileContent *string `type:"string" required:"true"` + + // The name of the authentication profile to be created. + // + // AuthenticationProfileName is a required field + AuthenticationProfileName *string `type:"string" required:"true"` +} + +// String returns the string representation +func (s CreateAuthenticationProfileInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAuthenticationProfileInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateAuthenticationProfileInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAuthenticationProfileInput"} + if s.AuthenticationProfileContent == nil { + invalidParams.Add(request.NewErrParamRequired("AuthenticationProfileContent")) + } + if s.AuthenticationProfileName == nil { + invalidParams.Add(request.NewErrParamRequired("AuthenticationProfileName")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAuthenticationProfileContent sets the AuthenticationProfileContent field's value. +func (s *CreateAuthenticationProfileInput) SetAuthenticationProfileContent(v string) *CreateAuthenticationProfileInput { + s.AuthenticationProfileContent = &v + return s +} + +// SetAuthenticationProfileName sets the AuthenticationProfileName field's value. +func (s *CreateAuthenticationProfileInput) SetAuthenticationProfileName(v string) *CreateAuthenticationProfileInput { + s.AuthenticationProfileName = &v + return s +} + +type CreateAuthenticationProfileOutput struct { + _ struct{} `type:"structure"` + + // The content of the authentication profile in JSON format. + AuthenticationProfileContent *string `type:"string"` + + // The name of the authentication profile that was created. + AuthenticationProfileName *string `type:"string"` +} + +// String returns the string representation +func (s CreateAuthenticationProfileOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAuthenticationProfileOutput) GoString() string { + return s.String() +} + +// SetAuthenticationProfileContent sets the AuthenticationProfileContent field's value. +func (s *CreateAuthenticationProfileOutput) SetAuthenticationProfileContent(v string) *CreateAuthenticationProfileOutput { + s.AuthenticationProfileContent = &v + return s +} + +// SetAuthenticationProfileName sets the AuthenticationProfileName field's value. +func (s *CreateAuthenticationProfileOutput) SetAuthenticationProfileName(v string) *CreateAuthenticationProfileOutput { + s.AuthenticationProfileName = &v + return s +} + type CreateClusterInput struct { _ struct{} `type:"structure"` @@ -13790,8 +14254,8 @@ type CreateClusterInput struct { // The value represents how the cluster is configured to use AQUA (Advanced // Query Accelerator) when it is created. Possible values include the following. // - // * enabled - Use AQUA if it is available for the current AWS Region and - // Amazon Redshift node type. + // * enabled - Use AQUA if it is available for the current Region and Amazon + // Redshift node type. // // * disabled - Don't use AQUA. // @@ -13842,7 +14306,7 @@ type CreateClusterInput struct { // // * Cannot end with a hyphen or contain two consecutive hyphens. // - // * Must be unique for all clusters within an AWS account. + // * Must be unique for all clusters within an account. // // Example: myexamplecluster // @@ -13948,16 +14412,16 @@ type CreateClusterInput struct { // the Amazon Redshift cluster can use to retrieve and store keys in an HSM. HsmConfigurationIdentifier *string `type:"string"` - // A list of AWS Identity and Access Management (IAM) roles that can be used - // by the cluster to access other AWS services. You must supply the IAM roles - // in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles - // in a single request. + // A list of Identity and Access Management (IAM) roles that can be used by + // the cluster to access other Amazon Web Services services. You must supply + // the IAM roles in their Amazon Resource Name (ARN) format. You can supply + // up to 10 IAM roles in a single request. // // A cluster can have up to 10 IAM roles associated with it at any time. IamRoles []*string `locationNameList:"IamRoleArn" type:"list"` - // The AWS Key Management Service (KMS) key ID of the encryption key that you - // want to use to encrypt data in the cluster. + // The Key Management Service (KMS) key ID of the encryption key that you want + // to use to encrypt data in the cluster. KmsKeyId *string `type:"string"` // An optional parameter for the name of the maintenance track for the cluster. @@ -13972,7 +14436,7 @@ type CreateClusterInput struct { // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int64 `type:"integer"` - // The password associated with the master user account for the cluster that + // The password associated with the admin user account for the cluster that // is being created. // // Constraints: @@ -13991,7 +14455,7 @@ type CreateClusterInput struct { // MasterUserPassword is a required field MasterUserPassword *string `type:"string" required:"true"` - // The user name associated with the master user account for the cluster that + // The user name associated with the admin user account for the cluster that // is being created. // // Constraints: @@ -14335,8 +14799,8 @@ type CreateClusterParameterGroupInput struct { // // To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. // By default, Amazon Redshift returns a list of all the parameter groups that - // are owned by your AWS account, including the default parameter groups for - // each Amazon Redshift engine version. The parameter group family names associated + // are owned by your account, including the default parameter groups for each + // Amazon Redshift engine version. The parameter group family names associated // with the default parameter groups provide you the valid values. For example, // a valid family name is "redshift-1.0". // @@ -14353,7 +14817,7 @@ type CreateClusterParameterGroupInput struct { // // * Cannot end with a hyphen or contain two consecutive hyphens. // - // * Must be unique withing your AWS account. + // * Must be unique withing your account. // // This value is stored as a lower-case string. // @@ -14452,8 +14916,7 @@ type CreateClusterSecurityGroupInput struct { // // * Must not be "Default". // - // * Must be unique for all security groups that are created by your AWS - // account. + // * Must be unique for all security groups that are created by your account. // // Example: examplesecuritygroup // @@ -14553,7 +15016,7 @@ type CreateClusterSnapshotInput struct { ManualSnapshotRetentionPeriod *int64 `type:"integer"` // A unique identifier for the snapshot that you are requesting. This identifier - // must be unique for all snapshots within the AWS account. + // must be unique for all snapshots within the account. // // Constraints: // @@ -14659,7 +15122,7 @@ type CreateClusterSubnetGroupInput struct { // // * Must not be "Default". // - // * Must be unique for all subnet groups that are created by your AWS account. + // * Must be unique for all subnet groups that are created by your account. // // Example: examplesubnetgroup // @@ -14772,8 +15235,8 @@ type CreateEndpointAccessInput struct { // EndpointName is a required field EndpointName *string `type:"string" required:"true"` - // The AWS account ID of the owner of the cluster. This is only required if - // the cluster is in another AWS account. + // The account ID of the owner of the cluster. This is only required if the + // cluster is in another account. ResourceOwner *string `type:"string"` // The subnet group from which Amazon Redshift chooses the subnet to deploy @@ -14865,7 +15328,7 @@ type CreateEndpointAccessOutput struct { // The port number on which the cluster accepts incoming connections. Port *int64 `type:"integer"` - // The AWS account ID of the owner of the cluster. + // The account ID of the owner of the cluster. ResourceOwner *string `type:"string"` // The subnet group name where Amazon Redshift chooses to deploy the endpoint. @@ -14989,7 +15452,7 @@ type CreateEventSubscriptionInput struct { // The type of source that will be generating the events. For example, if you // want to be notified of events generated by a cluster, you would set this // parameter to cluster. If this value is not specified, events are returned - // for all Amazon Redshift objects in your AWS account. You must specify a source + // for all Amazon Redshift objects in your account. You must specify a source // type in order to specify source IDs. // // Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, @@ -15582,7 +16045,7 @@ type CreateSnapshotCopyGrantInput struct { KmsKeyId *string `type:"string"` // The name of the snapshot copy grant. This name must be unique in the region - // for the AWS account. + // for the account. // // Constraints: // @@ -15594,7 +16057,7 @@ type CreateSnapshotCopyGrantInput struct { // // * Cannot end with a hyphen or contain two consecutive hyphens. // - // * Must be unique for all clusters within an AWS account. + // * Must be unique for all clusters within an account. // // SnapshotCopyGrantName is a required field SnapshotCopyGrantName *string `type:"string" required:"true"` @@ -15648,8 +16111,8 @@ type CreateSnapshotCopyGrantOutput struct { _ struct{} `type:"structure"` // The snapshot copy grant that grants Amazon Redshift permission to encrypt - // copied snapshots with the specified customer master key (CMK) from AWS KMS - // in the destination region. + // copied snapshots with the specified customer master key (CMK) from Amazon + // Web Services KMS in the destination region. // // For more information about managing snapshot copy grants, go to Amazon Redshift // Database Encryption (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) @@ -16262,6 +16725,67 @@ func (s *DeferredMaintenanceWindow) SetDeferMaintenanceStartTime(v time.Time) *D return s } +type DeleteAuthenticationProfileInput struct { + _ struct{} `type:"structure"` + + // The name of the authentication profile to delete. + // + // AuthenticationProfileName is a required field + AuthenticationProfileName *string `type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteAuthenticationProfileInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAuthenticationProfileInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteAuthenticationProfileInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAuthenticationProfileInput"} + if s.AuthenticationProfileName == nil { + invalidParams.Add(request.NewErrParamRequired("AuthenticationProfileName")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAuthenticationProfileName sets the AuthenticationProfileName field's value. +func (s *DeleteAuthenticationProfileInput) SetAuthenticationProfileName(v string) *DeleteAuthenticationProfileInput { + s.AuthenticationProfileName = &v + return s +} + +type DeleteAuthenticationProfileOutput struct { + _ struct{} `type:"structure"` + + // The name of the authentication profile that was deleted. + AuthenticationProfileName *string `type:"string"` +} + +// String returns the string representation +func (s DeleteAuthenticationProfileOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAuthenticationProfileOutput) GoString() string { + return s.String() +} + +// SetAuthenticationProfileName sets the AuthenticationProfileName field's value. +func (s *DeleteAuthenticationProfileOutput) SetAuthenticationProfileName(v string) *DeleteAuthenticationProfileOutput { + s.AuthenticationProfileName = &v + return s +} + type DeleteClusterInput struct { _ struct{} `type:"structure"` @@ -16735,7 +17259,7 @@ type DeleteEndpointAccessOutput struct { // The port number on which the cluster accepts incoming connections. Port *int64 `type:"integer"` - // The AWS account ID of the owner of the cluster. + // The account ID of the owner of the cluster. ResourceOwner *string `type:"string"` // The subnet group name where Amazon Redshift chooses to deploy the endpoint. @@ -16978,7 +17502,7 @@ func (s DeleteHsmConfigurationOutput) GoString() string { type DeletePartnerInput struct { _ struct{} `type:"structure"` - // The AWS account ID that owns the cluster. + // The Region ID that owns the cluster. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` @@ -17413,6 +17937,53 @@ func (s *DescribeAccountAttributesOutput) SetAccountAttributes(v []*AccountAttri return s } +type DescribeAuthenticationProfilesInput struct { + _ struct{} `type:"structure"` + + // The name of the authentication profile to describe. If not specified then + // all authentication profiles owned by the account are listed. + AuthenticationProfileName *string `type:"string"` +} + +// String returns the string representation +func (s DescribeAuthenticationProfilesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeAuthenticationProfilesInput) GoString() string { + return s.String() +} + +// SetAuthenticationProfileName sets the AuthenticationProfileName field's value. +func (s *DescribeAuthenticationProfilesInput) SetAuthenticationProfileName(v string) *DescribeAuthenticationProfilesInput { + s.AuthenticationProfileName = &v + return s +} + +type DescribeAuthenticationProfilesOutput struct { + _ struct{} `type:"structure"` + + // The list of authentication profiles. + AuthenticationProfiles []*AuthenticationProfile `type:"list"` +} + +// String returns the string representation +func (s DescribeAuthenticationProfilesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeAuthenticationProfilesOutput) GoString() string { + return s.String() +} + +// SetAuthenticationProfiles sets the AuthenticationProfiles field's value. +func (s *DescribeAuthenticationProfilesOutput) SetAuthenticationProfiles(v []*AuthenticationProfile) *DescribeAuthenticationProfilesOutput { + s.AuthenticationProfiles = v + return s +} + type DescribeClusterDbRevisionsInput struct { _ struct{} `type:"structure"` @@ -17512,10 +18083,10 @@ type DescribeClusterParameterGroupsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterParameterGroups request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -17632,10 +18203,10 @@ type DescribeClusterParametersInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterParameters request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -17760,10 +18331,10 @@ type DescribeClusterSecurityGroupsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterSecurityGroups request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. // // Constraints: You can specify either the ClusterSecurityGroupName parameter // or the Marker parameter, but not both. @@ -17905,10 +18476,10 @@ type DescribeClusterSnapshotsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterSnapshots request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -17921,10 +18492,9 @@ type DescribeClusterSnapshotsInput struct { // Constraints: minimum 20, maximum 100. MaxRecords *int64 `type:"integer"` - // The AWS customer account used to create or copy the snapshot. Use this field - // to filter the results to snapshots owned by a particular account. To describe - // snapshots you own, either specify your AWS customer account, or do not specify - // the parameter. + // The account used to create or copy the snapshot. Use this field to filter + // the results to snapshots owned by a particular account. To describe snapshots + // you own, either specify your account, or do not specify the parameter. OwnerAccount *string `type:"string"` // The snapshot identifier of the snapshot about which to return information. @@ -18109,10 +18679,10 @@ type DescribeClusterSubnetGroupsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterSubnetGroups request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -18320,9 +18890,10 @@ type DescribeClusterVersionsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterVersions request exceed - // the value specified in MaxRecords, AWS returns a value in the Marker field - // of the response. You can retrieve the next set of response records by providing - // the returned marker value in the Marker parameter and retrying the request. + // the value specified in MaxRecords, Amazon Web Services returns a value in + // the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -18418,9 +18989,10 @@ type DescribeClustersInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusters request exceed the - // value specified in MaxRecords, AWS returns a value in the Marker field of - // the response. You can retrieve the next set of response records by providing - // the returned marker value in the Marker parameter and retrying the request. + // value specified in MaxRecords, Amazon Web Services returns a value in the + // Marker field of the response. You can retrieve the next set of response records + // by providing the returned marker value in the Marker parameter and retrying + // the request. // // Constraints: You can specify either the ClusterIdentifier parameter or the // Marker parameter, but not both. @@ -18535,10 +19107,10 @@ type DescribeDefaultClusterParametersInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeDefaultClusterParameters - // request exceed the value specified in MaxRecords, AWS returns a value in - // the Marker field of the response. You can retrieve the next set of response - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // request exceed the value specified in MaxRecords, Amazon Web Services returns + // a value in the Marker field of the response. You can retrieve the next set + // of response records by providing the returned marker value in the Marker + // parameter and retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -18640,7 +19212,7 @@ type DescribeEndpointAccessInput struct { // is included in the response so that the remaining results can be retrieved. MaxRecords *int64 `type:"integer"` - // The AWS account ID of the owner of the cluster. + // The account ID of the owner of the cluster. ResourceOwner *string `type:"string"` // The virtual private cloud (VPC) identifier with access to the cluster. @@ -18730,7 +19302,7 @@ func (s *DescribeEndpointAccessOutput) SetMarker(v string) *DescribeEndpointAcce type DescribeEndpointAuthorizationInput struct { _ struct{} `type:"structure"` - // The AWS account ID of either the cluster owner (grantor) or grantee. If Grantee + // The Aaccount ID of either the cluster owner (grantor) or grantee. If Grantee // parameter is true, then the Account value is of the grantor. Account *string `type:"string"` @@ -18883,10 +19455,10 @@ type DescribeEventSubscriptionsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeEventSubscriptions request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -19014,9 +19586,10 @@ type DescribeEventsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeEvents request exceed the - // value specified in MaxRecords, AWS returns a value in the Marker field of - // the response. You can retrieve the next set of response records by providing - // the returned marker value in the Marker parameter and retrying the request. + // value specified in MaxRecords, Amazon Web Services returns a value in the + // Marker field of the response. You can retrieve the next set of response records + // by providing the returned marker value in the Marker parameter and retrying + // the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -19165,15 +19738,15 @@ type DescribeHsmClientCertificatesInput struct { // The identifier of a specific HSM client certificate for which you want information. // If no identifier is specified, information is returned for all HSM client - // certificates owned by your AWS customer account. + // certificates owned by your account. HsmClientCertificateIdentifier *string `type:"string"` // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeHsmClientCertificates request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -19286,15 +19859,15 @@ type DescribeHsmConfigurationsInput struct { // The identifier of a specific Amazon Redshift HSM configuration to be described. // If no identifier is specified, information is returned for all HSM configurations - // owned by your AWS customer account. + // owned by your account. HsmConfigurationIdentifier *string `type:"string"` // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeHsmConfigurations request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -19460,10 +20033,10 @@ type DescribeNodeConfigurationOptionsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeNodeConfigurationOptions - // request exceed the value specified in MaxRecords, AWS returns a value in - // the Marker field of the response. You can retrieve the next set of response - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // request exceed the value specified in MaxRecords, Amazon Web Services returns + // a value in the Marker field of the response. You can retrieve the next set + // of response records by providing the returned marker value in the Marker + // parameter and retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -19476,8 +20049,8 @@ type DescribeNodeConfigurationOptionsInput struct { // Constraints: minimum 100, maximum 500. MaxRecords *int64 `type:"integer"` - // The AWS customer account used to create or copy the snapshot. Required if - // you are restoring a snapshot you do not own, optional if you own the snapshot. + // The account used to create or copy the snapshot. Required if you are restoring + // a snapshot you do not own, optional if you own the snapshot. OwnerAccount *string `type:"string"` // The identifier of the snapshot to evaluate for possible node configurations. @@ -19598,10 +20171,10 @@ type DescribeOrderableClusterOptionsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeOrderableClusterOptions request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -19694,7 +20267,7 @@ func (s *DescribeOrderableClusterOptionsOutput) SetOrderableClusterOptions(v []* type DescribePartnersInput struct { _ struct{} `type:"structure"` - // The AWS account ID that owns the cluster. + // The Region ID that owns the cluster. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` @@ -19795,10 +20368,10 @@ type DescribeReservedNodeOfferingsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeReservedNodeOfferings request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -19884,9 +20457,10 @@ type DescribeReservedNodesInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeReservedNodes request exceed - // the value specified in MaxRecords, AWS returns a value in the Marker field - // of the response. You can retrieve the next set of response records by providing - // the returned marker value in the Marker parameter and retrying the request. + // the value specified in MaxRecords, Amazon Web Services returns a value in + // the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -19973,8 +20547,8 @@ type DescribeResizeInput struct { // The unique identifier of a cluster whose resize progress you are requesting. // This parameter is case-sensitive. // - // By default, resize operations for all clusters defined for an AWS account - // are returned. + // By default, resize operations for all clusters defined for an account are + // returned. // // ClusterIdentifier is a required field ClusterIdentifier *string `type:"string" required:"true"` @@ -20210,10 +20784,10 @@ type DescribeScheduledActionsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeScheduledActions request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -20320,10 +20894,10 @@ type DescribeScheduledActionsOutput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeScheduledActions request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // List of retrieved scheduled actions. @@ -20358,10 +20932,10 @@ type DescribeSnapshotCopyGrantsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeSnapshotCopyGrant request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. // // Constraints: You can specify either the SnapshotCopyGrantName parameter or // the Marker parameter, but not both. @@ -20442,10 +21016,10 @@ type DescribeSnapshotCopyGrantsOutput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeSnapshotCopyGrant request - // exceed the value specified in MaxRecords, AWS returns a value in the Marker - // field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying - // the request. + // exceed the value specified in MaxRecords, Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. // // Constraints: You can specify either the SnapshotCopyGrantName parameter or // the Marker parameter, but not both. @@ -20883,9 +21457,10 @@ type DescribeUsageLimitsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeUsageLimits request exceed - // the value specified in MaxRecords, AWS returns a value in the Marker field - // of the response. You can retrieve the next set of response records by providing - // the returned marker value in the Marker parameter and retrying the request. + // the value specified in MaxRecords, Amazon Web Services returns a value in + // the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string `type:"string"` // The maximum number of response records to return in each call. If the number @@ -21118,7 +21693,7 @@ type EC2SecurityGroup struct { // The name of the EC2 Security Group. EC2SecurityGroupName *string `type:"string"` - // The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName + // The account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName // field. EC2SecurityGroupOwnerId *string `type:"string"` @@ -21284,18 +21859,18 @@ type EnableSnapshotCopyInput struct { // ClusterIdentifier is a required field ClusterIdentifier *string `type:"string" required:"true"` - // The destination AWS Region that you want to copy snapshots to. + // The destination Region that you want to copy snapshots to. // - // Constraints: Must be the name of a valid AWS Region. For more information, - // see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region) + // Constraints: Must be the name of a valid Region. For more information, see + // Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region) // in the Amazon Web Services General Reference. // // DestinationRegion is a required field DestinationRegion *string `type:"string" required:"true"` - // The number of days to retain newly copied snapshots in the destination AWS - // Region after they are copied from the source AWS Region. If the value is - // -1, the manual snapshot is retained indefinitely. + // The number of days to retain newly copied snapshots in the destination Region + // after they are copied from the source Region. If the value is -1, the manual + // snapshot is retained indefinitely. // // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int64 `type:"integer"` @@ -21308,8 +21883,8 @@ type EnableSnapshotCopyInput struct { // Constraints: Must be at least 1 and no more than 35. RetentionPeriod *int64 `type:"integer"` - // The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted - // cluster are copied to the destination region. + // The name of the snapshot copy grant to use when snapshots of an Amazon Web + // Services KMS-encrypted cluster are copied to the destination region. SnapshotCopyGrantName *string `type:"string"` } @@ -21456,7 +22031,7 @@ type EndpointAccess struct { // The port number on which the cluster accepts incoming connections. Port *int64 `type:"integer"` - // The AWS account ID of the owner of the cluster. + // The account ID of the owner of the cluster. ResourceOwner *string `type:"string"` // The subnet group name where Amazon Redshift chooses to deploy the endpoint. @@ -21541,7 +22116,7 @@ func (s *EndpointAccess) SetVpcSecurityGroups(v []*VpcSecurityGroupMembership) * } // Describes an endpoint authorization for authorizing Redshift-managed VPC -// endpoint access to a cluster across AWS accounts. +// endpoint access to a cluster across accounts. type EndpointAuthorization struct { _ struct{} `type:"structure"` @@ -21564,10 +22139,10 @@ type EndpointAuthorization struct { // The number of Redshift-managed VPC endpoints created for the authorization. EndpointCount *int64 `type:"integer"` - // The AWS account ID of the grantee of the cluster. + // The account ID of the grantee of the cluster. Grantee *string `type:"string"` - // The AWS account ID of the cluster owner. + // The account ID of the cluster owner. Grantor *string `type:"string"` // The status of the authorization action. @@ -21814,8 +22389,7 @@ type EventSubscription struct { // The name of the Amazon Redshift event notification subscription. CustSubscriptionId *string `type:"string"` - // The AWS customer account associated with the Amazon Redshift event notification - // subscription. + // The account associated with the Amazon Redshift event notification subscription. CustomerAwsId *string `type:"string"` // A boolean value indicating whether the subscription is enabled; true indicates @@ -22554,8 +23128,8 @@ type ModifyAquaConfigurationInput struct { // The new value of AQUA configuration status. Possible values include the following. // - // * enabled - Use AQUA if it is available for the current AWS Region and - // Amazon Redshift node type. + // * enabled - Use AQUA if it is available for the current Region and Amazon + // Redshift node type. // // * disabled - Don't use AQUA. // @@ -22626,6 +23200,91 @@ func (s *ModifyAquaConfigurationOutput) SetAquaConfiguration(v *AquaConfiguratio return s } +type ModifyAuthenticationProfileInput struct { + _ struct{} `type:"structure"` + + // The new content of the authentication profile in JSON format. The maximum + // length of the JSON string is determined by a quota for your account. + // + // AuthenticationProfileContent is a required field + AuthenticationProfileContent *string `type:"string" required:"true"` + + // The name of the authentication profile to replace. + // + // AuthenticationProfileName is a required field + AuthenticationProfileName *string `type:"string" required:"true"` +} + +// String returns the string representation +func (s ModifyAuthenticationProfileInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ModifyAuthenticationProfileInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModifyAuthenticationProfileInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModifyAuthenticationProfileInput"} + if s.AuthenticationProfileContent == nil { + invalidParams.Add(request.NewErrParamRequired("AuthenticationProfileContent")) + } + if s.AuthenticationProfileName == nil { + invalidParams.Add(request.NewErrParamRequired("AuthenticationProfileName")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAuthenticationProfileContent sets the AuthenticationProfileContent field's value. +func (s *ModifyAuthenticationProfileInput) SetAuthenticationProfileContent(v string) *ModifyAuthenticationProfileInput { + s.AuthenticationProfileContent = &v + return s +} + +// SetAuthenticationProfileName sets the AuthenticationProfileName field's value. +func (s *ModifyAuthenticationProfileInput) SetAuthenticationProfileName(v string) *ModifyAuthenticationProfileInput { + s.AuthenticationProfileName = &v + return s +} + +type ModifyAuthenticationProfileOutput struct { + _ struct{} `type:"structure"` + + // The updated content of the authentication profile in JSON format. + AuthenticationProfileContent *string `type:"string"` + + // The name of the authentication profile that was replaced. + AuthenticationProfileName *string `type:"string"` +} + +// String returns the string representation +func (s ModifyAuthenticationProfileOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ModifyAuthenticationProfileOutput) GoString() string { + return s.String() +} + +// SetAuthenticationProfileContent sets the AuthenticationProfileContent field's value. +func (s *ModifyAuthenticationProfileOutput) SetAuthenticationProfileContent(v string) *ModifyAuthenticationProfileOutput { + s.AuthenticationProfileContent = &v + return s +} + +// SetAuthenticationProfileName sets the AuthenticationProfileName field's value. +func (s *ModifyAuthenticationProfileOutput) SetAuthenticationProfileName(v string) *ModifyAuthenticationProfileOutput { + s.AuthenticationProfileName = &v + return s +} + type ModifyClusterDbRevisionInput struct { _ struct{} `type:"structure"` @@ -22910,8 +23569,8 @@ type ModifyClusterInput struct { // the Amazon Redshift cluster can use to retrieve and store keys in an HSM. HsmConfigurationIdentifier *string `type:"string"` - // The AWS Key Management Service (KMS) key ID of the encryption key that you - // want to use to encrypt data in the cluster. + // The Key Management Service (KMS) key ID of the encryption key that you want + // to use to encrypt data in the cluster. KmsKeyId *string `type:"string"` // The name for the maintenance track that you want to assign for the cluster. @@ -22930,13 +23589,13 @@ type ModifyClusterInput struct { // The default value is -1. ManualSnapshotRetentionPeriod *int64 `type:"integer"` - // The new password for the cluster master user. This change is asynchronously + // The new password for the cluster admin user. This change is asynchronously // applied as soon as possible. Between the time of the request and the completion // of the request, the MasterUserPassword element exists in the PendingModifiedValues // element of the operation response. // // Operations never return the password, so this operation provides a way to - // regain access to the master user account for a cluster if the password is + // regain access to the admin user account for a cluster if the password is // lost. // // Default: Uses existing setting. @@ -22967,7 +23626,7 @@ type ModifyClusterInput struct { // // * Cannot end with a hyphen or contain two consecutive hyphens. // - // * Must be unique for all clusters within an AWS account. + // * Must be unique for all clusters within an account. // // Example: examplecluster NewClusterIdentifier *string `type:"string"` @@ -23701,7 +24360,7 @@ type ModifyEndpointAccessOutput struct { // The port number on which the cluster accepts incoming connections. Port *int64 `type:"integer"` - // The AWS account ID of the owner of the cluster. + // The account ID of the owner of the cluster. ResourceOwner *string `type:"string"` // The subnet group name where Amazon Redshift chooses to deploy the endpoint. @@ -23822,7 +24481,7 @@ type ModifyEventSubscriptionInput struct { // The type of source that will be generating the events. For example, if you // want to be notified of events generated by a cluster, you would set this // parameter to cluster. If this value is not specified, events are returned - // for all Amazon Redshift objects in your AWS account. You must specify a source + // for all Amazon Redshift objects in your account. You must specify a source // type in order to specify source IDs. // // Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, @@ -24156,7 +24815,7 @@ type ModifySnapshotCopyRetentionPeriodInput struct { // The unique identifier of the cluster for which you want to change the retention // period for either automated or manual snapshots that are copied to a destination - // AWS Region. + // Region. // // Constraints: Must be the valid name of an existing cluster that has cross-region // snapshot copy enabled. @@ -24168,15 +24827,15 @@ type ModifySnapshotCopyRetentionPeriodInput struct { // manual snapshots instead of automated snapshots. Manual *bool `type:"boolean"` - // The number of days to retain automated snapshots in the destination AWS Region - // after they are copied from the source AWS Region. + // The number of days to retain automated snapshots in the destination Region + // after they are copied from the source Region. // // By default, this only changes the retention period of copied automated snapshots. // // If you decrease the retention period for automated snapshots that are copied - // to a destination AWS Region, Amazon Redshift deletes any existing automated - // snapshots that were copied to the destination AWS Region and that fall outside - // of the new retention period. + // to a destination Region, Amazon Redshift deletes any existing automated snapshots + // that were copied to the destination Region and that fall outside of the new + // retention period. // // Constraints: Must be at least 1 and no more than 35 for automated snapshots. // @@ -25058,7 +25717,7 @@ type PendingModifiedValues struct { // the next maintenance window. MaintenanceTrackName *string `type:"string"` - // The pending or in-progress change of the master user password for the cluster. + // The pending or in-progress change of the admin user password for the cluster. MasterUserPassword *string `type:"string"` // The pending or in-progress change of the cluster's node type. @@ -25859,8 +26518,8 @@ type RestoreFromClusterSnapshotInput struct { // Query Accelerator) after the cluster is restored. Possible values include // the following. // - // * enabled - Use AQUA if it is available for the current AWS Region and - // Amazon Redshift node type. + // * enabled - Use AQUA if it is available for the current Region and Amazon + // Redshift node type. // // * disabled - Don't use AQUA. // @@ -25902,7 +26561,7 @@ type RestoreFromClusterSnapshotInput struct { // // * Cannot end with a hyphen or contain two consecutive hyphens. // - // * Must be unique for all clusters within an AWS account. + // * Must be unique for all clusters within an account. // // ClusterIdentifier is a required field ClusterIdentifier *string `type:"string" required:"true"` @@ -25957,17 +26616,16 @@ type RestoreFromClusterSnapshotInput struct { // the Amazon Redshift cluster can use to retrieve and store keys in an HSM. HsmConfigurationIdentifier *string `type:"string"` - // A list of AWS Identity and Access Management (IAM) roles that can be used - // by the cluster to access other AWS services. You must supply the IAM roles - // in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles - // in a single request. + // A list of Identity and Access Management (IAM) roles that can be used by + // the cluster to access other Amazon Web Services services. You must supply + // the IAM roles in their Amazon Resource Name (ARN) format. You can supply + // up to 10 IAM roles in a single request. // // A cluster can have up to 10 IAM roles associated at any time. IamRoles []*string `locationNameList:"IamRoleArn" type:"list"` - // The AWS Key Management Service (KMS) key ID of the encryption key that you - // want to use to encrypt data in the cluster that you restore from a shared - // snapshot. + // The Key Management Service (KMS) key ID of the encryption key that you want + // to use to encrypt data in the cluster that you restore from a shared snapshot. KmsKeyId *string `type:"string"` // The name of the maintenance track for the restored cluster. When you take @@ -26004,8 +26662,8 @@ type RestoreFromClusterSnapshotInput struct { // The number of nodes specified when provisioning the restored cluster. NumberOfNodes *int64 `type:"integer"` - // The AWS customer account used to create or copy the snapshot. Required if - // you are restoring a snapshot you do not own, optional if you own the snapshot. + // The account used to create or copy the snapshot. Required if you are restoring + // a snapshot you do not own, optional if you own the snapshot. OwnerAccount *string `type:"string"` // The port number on which the cluster accepts connections. @@ -26677,10 +27335,10 @@ type RevokeClusterSecurityGroupIngressInput struct { // be provided. EC2SecurityGroupName *string `type:"string"` - // The AWS account number of the owner of the security group specified in the - // EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable - // value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must - // also be provided. and CIDRIP cannot be provided. + // The account number of the owner of the security group specified in the EC2SecurityGroupName + // parameter. The Amazon Web Services access key ID is not an acceptable value. + // If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be + // provided. and CIDRIP cannot be provided. // // Example: 111122223333 EC2SecurityGroupOwnerId *string `type:"string"` @@ -26759,7 +27417,7 @@ func (s *RevokeClusterSecurityGroupIngressOutput) SetClusterSecurityGroup(v *Clu type RevokeEndpointAccessInput struct { _ struct{} `type:"structure"` - // The AWS account ID whose access is to be revoked. + // The account ID whose access is to be revoked. Account *string `type:"string"` // The cluster to revoke access from. @@ -26808,7 +27466,7 @@ func (s *RevokeEndpointAccessInput) SetVpcIds(v []*string) *RevokeEndpointAccess } // Describes an endpoint authorization for authorizing Redshift-managed VPC -// endpoint access to a cluster across AWS accounts. +// endpoint access to a cluster across accounts. type RevokeEndpointAccessOutput struct { _ struct{} `type:"structure"` @@ -26831,10 +27489,10 @@ type RevokeEndpointAccessOutput struct { // The number of Redshift-managed VPC endpoints created for the authorization. EndpointCount *int64 `type:"integer"` - // The AWS account ID of the grantee of the cluster. + // The account ID of the grantee of the cluster. Grantee *string `type:"string"` - // The AWS account ID of the cluster owner. + // The account ID of the cluster owner. Grantor *string `type:"string"` // The status of the authorization action. @@ -26908,8 +27566,7 @@ func (s *RevokeEndpointAccessOutput) SetStatus(v string) *RevokeEndpointAccessOu type RevokeSnapshotAccessInput struct { _ struct{} `type:"structure"` - // The identifier of the AWS customer account that can no longer restore the - // specified snapshot. + // The identifier of the account that can no longer restore the specified snapshot. // // AccountWithRestoreAccess is a required field AccountWithRestoreAccess *string `type:"string" required:"true"` @@ -27298,8 +27955,8 @@ func (s *ScheduledActionType) SetResumeCluster(v *ResumeClusterMessage) *Schedul type Snapshot struct { _ struct{} `type:"structure"` - // A list of the AWS customer accounts authorized to restore the snapshot. Returns - // null if no accounts are authorized. Visible only to the snapshot owner. + // A list of the accounts authorized to restore the snapshot. Returns null if + // no accounts are authorized. Visible only to the snapshot owner. AccountsWithRestoreAccess []*AccountWithRestoreAccess `locationNameList:"AccountWithRestoreAccess" type:"list"` // The size of the incremental backup. @@ -27358,8 +28015,8 @@ type Snapshot struct { // Returns 0 for a completed backup. EstimatedSecondsToCompletion *int64 `type:"long"` - // The AWS Key Management Service (KMS) key ID of the encryption key that was - // used to encrypt data in the cluster from which the snapshot was taken. + // The Key Management Service (KMS) key ID of the encryption key that was used + // to encrypt data in the cluster from which the snapshot was taken. KmsKeyId *string `type:"string"` // The name of the maintenance track for the snapshot. @@ -27374,7 +28031,7 @@ type Snapshot struct { // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int64 `type:"integer"` - // The master user name for the cluster. + // The admin user name for the cluster. MasterUsername *string `type:"string"` // The node type of the nodes in the cluster. @@ -27383,9 +28040,9 @@ type Snapshot struct { // The number of nodes in the cluster. NumberOfNodes *int64 `type:"integer"` - // For manual snapshots, the AWS customer account used to create or copy the - // snapshot. For automatic snapshots, the owner of the cluster. The owner can - // perform all snapshot actions, such as sharing a manual snapshot. + // For manual snapshots, the account used to create or copy the snapshot. For + // automatic snapshots, the owner of the cluster. The owner can perform all + // snapshot actions, such as sharing a manual snapshot. OwnerAccount *string `type:"string"` // The port that the cluster is listening on. @@ -27649,8 +28306,8 @@ func (s *Snapshot) SetVpcId(v string) *Snapshot { } // The snapshot copy grant that grants Amazon Redshift permission to encrypt -// copied snapshots with the specified customer master key (CMK) from AWS KMS -// in the destination region. +// copied snapshots with the specified customer master key (CMK) from Amazon +// Web Services KMS in the destination region. // // For more information about managing snapshot copy grants, go to Amazon Redshift // Database Encryption (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) @@ -27658,8 +28315,8 @@ func (s *Snapshot) SetVpcId(v string) *Snapshot { type SnapshotCopyGrant struct { _ struct{} `type:"structure"` - // The unique identifier of the customer master key (CMK) in AWS KMS to which - // Amazon Redshift is granted permission. + // The unique identifier of the customer master key (CMK) in Amazon Web Services + // KMS to which Amazon Redshift is granted permission. KmsKeyId *string `type:"string"` // The name of the snapshot copy grant. @@ -28212,7 +28869,7 @@ func (s *TaggedResource) SetTag(v *Tag) *TaggedResource { type UpdatePartnerStatusInput struct { _ struct{} `type:"structure"` - // The AWS account ID that owns the cluster. + // The Region ID that owns the cluster. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` diff --git a/service/redshift/errors.go b/service/redshift/errors.go index 82398f6a685..65e5d87e281 100644 --- a/service/redshift/errors.go +++ b/service/redshift/errors.go @@ -17,6 +17,26 @@ const ( // the snapshot. ErrCodeAccessToSnapshotDeniedFault = "AccessToSnapshotDenied" + // ErrCodeAuthenticationProfileAlreadyExistsFault for service response error code + // "AuthenticationProfileAlreadyExistsFault". + // + // The authentication profile already exists. + ErrCodeAuthenticationProfileAlreadyExistsFault = "AuthenticationProfileAlreadyExistsFault" + + // ErrCodeAuthenticationProfileNotFoundFault for service response error code + // "AuthenticationProfileNotFoundFault". + // + // The authentication profile can't be found. + ErrCodeAuthenticationProfileNotFoundFault = "AuthenticationProfileNotFoundFault" + + // ErrCodeAuthenticationProfileQuotaExceededFault for service response error code + // "AuthenticationProfileQuotaExceededFault". + // + // The size or number of authentication profiles has exceeded the quota. The + // maximum length of the JSON string and maximum number of authentication profiles + // is determined by a quota for your account. + ErrCodeAuthenticationProfileQuotaExceededFault = "AuthenticationProfileQuotaExceededFault" + // ErrCodeAuthorizationAlreadyExistsFault for service response error code // "AuthorizationAlreadyExists". // @@ -319,6 +339,14 @@ const ( // bucket specified when enabling logging. ErrCodeInsufficientS3BucketPolicyFault = "InsufficientS3BucketPolicyFault" + // ErrCodeInvalidAuthenticationProfileRequestFault for service response error code + // "InvalidAuthenticationProfileRequestFault". + // + // The authentication profile request is not valid. The profile name can't be + // null or empty. The authentication profile API operation must be available + // in the Region. + ErrCodeInvalidAuthenticationProfileRequestFault = "InvalidAuthenticationProfileRequestFault" + // ErrCodeInvalidAuthorizationStateFault for service response error code // "InvalidAuthorizationState". // @@ -498,7 +526,7 @@ const ( // ErrCodeLimitExceededFault for service response error code // "LimitExceededFault". // - // The encryption key has exceeded its grant limit in AWS KMS. + // The encryption key has exceeded its grant limit in Amazon Web Services KMS. ErrCodeLimitExceededFault = "LimitExceededFault" // ErrCodeNumberOfNodesPerClusterLimitExceededFault for service response error code @@ -651,8 +679,8 @@ const ( // ErrCodeSnapshotCopyGrantQuotaExceededFault for service response error code // "SnapshotCopyGrantQuotaExceededFault". // - // The AWS account has exceeded the maximum number of snapshot copy grants in - // this region. + // The account has exceeded the maximum number of snapshot copy grants in this + // region. ErrCodeSnapshotCopyGrantQuotaExceededFault = "SnapshotCopyGrantQuotaExceededFault" // ErrCodeSnapshotScheduleAlreadyExistsFault for service response error code diff --git a/service/redshift/redshiftiface/interface.go b/service/redshift/redshiftiface/interface.go index 726f1232be6..7ac76e1daf2 100644 --- a/service/redshift/redshiftiface/interface.go +++ b/service/redshift/redshiftiface/interface.go @@ -96,6 +96,10 @@ type RedshiftAPI interface { CopyClusterSnapshotWithContext(aws.Context, *redshift.CopyClusterSnapshotInput, ...request.Option) (*redshift.CopyClusterSnapshotOutput, error) CopyClusterSnapshotRequest(*redshift.CopyClusterSnapshotInput) (*request.Request, *redshift.CopyClusterSnapshotOutput) + CreateAuthenticationProfile(*redshift.CreateAuthenticationProfileInput) (*redshift.CreateAuthenticationProfileOutput, error) + CreateAuthenticationProfileWithContext(aws.Context, *redshift.CreateAuthenticationProfileInput, ...request.Option) (*redshift.CreateAuthenticationProfileOutput, error) + CreateAuthenticationProfileRequest(*redshift.CreateAuthenticationProfileInput) (*request.Request, *redshift.CreateAuthenticationProfileOutput) + CreateCluster(*redshift.CreateClusterInput) (*redshift.CreateClusterOutput, error) CreateClusterWithContext(aws.Context, *redshift.CreateClusterInput, ...request.Option) (*redshift.CreateClusterOutput, error) CreateClusterRequest(*redshift.CreateClusterInput) (*request.Request, *redshift.CreateClusterOutput) @@ -152,6 +156,10 @@ type RedshiftAPI interface { CreateUsageLimitWithContext(aws.Context, *redshift.CreateUsageLimitInput, ...request.Option) (*redshift.CreateUsageLimitOutput, error) CreateUsageLimitRequest(*redshift.CreateUsageLimitInput) (*request.Request, *redshift.CreateUsageLimitOutput) + DeleteAuthenticationProfile(*redshift.DeleteAuthenticationProfileInput) (*redshift.DeleteAuthenticationProfileOutput, error) + DeleteAuthenticationProfileWithContext(aws.Context, *redshift.DeleteAuthenticationProfileInput, ...request.Option) (*redshift.DeleteAuthenticationProfileOutput, error) + DeleteAuthenticationProfileRequest(*redshift.DeleteAuthenticationProfileInput) (*request.Request, *redshift.DeleteAuthenticationProfileOutput) + DeleteCluster(*redshift.DeleteClusterInput) (*redshift.DeleteClusterOutput, error) DeleteClusterWithContext(aws.Context, *redshift.DeleteClusterInput, ...request.Option) (*redshift.DeleteClusterOutput, error) DeleteClusterRequest(*redshift.DeleteClusterInput) (*request.Request, *redshift.DeleteClusterOutput) @@ -216,6 +224,10 @@ type RedshiftAPI interface { DescribeAccountAttributesWithContext(aws.Context, *redshift.DescribeAccountAttributesInput, ...request.Option) (*redshift.DescribeAccountAttributesOutput, error) DescribeAccountAttributesRequest(*redshift.DescribeAccountAttributesInput) (*request.Request, *redshift.DescribeAccountAttributesOutput) + DescribeAuthenticationProfiles(*redshift.DescribeAuthenticationProfilesInput) (*redshift.DescribeAuthenticationProfilesOutput, error) + DescribeAuthenticationProfilesWithContext(aws.Context, *redshift.DescribeAuthenticationProfilesInput, ...request.Option) (*redshift.DescribeAuthenticationProfilesOutput, error) + DescribeAuthenticationProfilesRequest(*redshift.DescribeAuthenticationProfilesInput) (*request.Request, *redshift.DescribeAuthenticationProfilesOutput) + DescribeClusterDbRevisions(*redshift.DescribeClusterDbRevisionsInput) (*redshift.DescribeClusterDbRevisionsOutput, error) DescribeClusterDbRevisionsWithContext(aws.Context, *redshift.DescribeClusterDbRevisionsInput, ...request.Option) (*redshift.DescribeClusterDbRevisionsOutput, error) DescribeClusterDbRevisionsRequest(*redshift.DescribeClusterDbRevisionsInput) (*request.Request, *redshift.DescribeClusterDbRevisionsOutput) @@ -449,6 +461,10 @@ type RedshiftAPI interface { ModifyAquaConfigurationWithContext(aws.Context, *redshift.ModifyAquaConfigurationInput, ...request.Option) (*redshift.ModifyAquaConfigurationOutput, error) ModifyAquaConfigurationRequest(*redshift.ModifyAquaConfigurationInput) (*request.Request, *redshift.ModifyAquaConfigurationOutput) + ModifyAuthenticationProfile(*redshift.ModifyAuthenticationProfileInput) (*redshift.ModifyAuthenticationProfileOutput, error) + ModifyAuthenticationProfileWithContext(aws.Context, *redshift.ModifyAuthenticationProfileInput, ...request.Option) (*redshift.ModifyAuthenticationProfileOutput, error) + ModifyAuthenticationProfileRequest(*redshift.ModifyAuthenticationProfileInput) (*request.Request, *redshift.ModifyAuthenticationProfileOutput) + ModifyCluster(*redshift.ModifyClusterInput) (*redshift.ModifyClusterOutput, error) ModifyClusterWithContext(aws.Context, *redshift.ModifyClusterInput, ...request.Option) (*redshift.ModifyClusterOutput, error) ModifyClusterRequest(*redshift.ModifyClusterInput) (*request.Request, *redshift.ModifyClusterOutput) diff --git a/service/ssm/api.go b/service/ssm/api.go index 7c219cae5e8..bc9f40f7797 100644 --- a/service/ssm/api.go +++ b/service/ssm/api.go @@ -65,8 +65,19 @@ func (c *SSM) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *requ // owner, or environment. Each tag consists of a key and an optional value, // both of which you define. For example, you could define a set of tags for // your account's managed instances that helps you track each instance's owner -// and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. -// Or Key=Stack and Value=Production, Pre-Production, or Test. +// and stack level. For example: +// +// * Key=Owner,Value=DbAdmin +// +// * Key=Owner,Value=SysAdmin +// +// * Key=Owner,Value=Dev +// +// * Key=Stack,Value=Production +// +// * Key=Stack,Value=Pre-Production +// +// * Key=Stack,Value=Test // // Each resource can have a maximum of 50 tags. // @@ -76,8 +87,8 @@ func (c *SSM) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *requ // on the tags you add. Tags don't have any semantic meaning to and are interpreted // strictly as a string of characters. // -// For more information about using tags with EC2 instances, see Tagging your -// Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) +// For more information about using tags with Amazon Elastic Compute Cloud (Amazon +// EC2) instances, see Tagging your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) // in the Amazon EC2 User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -89,12 +100,12 @@ func (c *SSM) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *requ // // Returned Error Types: // * InvalidResourceType -// The resource type is not valid. For example, if you are attempting to tag +// The resource type isn't valid. For example, if you are attempting to tag // an instance, the instance must be a registered, managed instance. // // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // * InternalServerError // An error occurred on the server side. @@ -175,7 +186,8 @@ func (c *SSM) AssociateOpsItemRelatedItemRequest(input *AssociateOpsItemRelatedI // // Associates a related resource to a Systems Manager OpsCenter OpsItem. For // example, you can associate an Incident Manager incident or analysis with -// an OpsItem. Incident Manager is a capability of AWS Systems Manager. +// an OpsItem. Incident Manager is a capability of Amazon Web Services Systems +// Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -284,22 +296,24 @@ func (c *SSM) CancelCommandRequest(input *CancelCommandInput) (req *request.Requ // An error occurred on the server side. // // * InvalidCommandId -// The specified command ID is not valid. Verify the ID and try again. +// The specified command ID isn't valid. Verify the ID and try again. // // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * DuplicateInstanceId -// You cannot specify an instance ID in more than one association. +// You can't specify an instance ID in more than one association. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CancelCommand func (c *SSM) CancelCommand(input *CancelCommandInput) (*CancelCommandOutput, error) { @@ -368,8 +382,8 @@ func (c *SSM) CancelMaintenanceWindowExecutionRequest(input *CancelMaintenanceWi // CancelMaintenanceWindowExecution API operation for Amazon Simple Systems Manager (SSM). // // Stops a maintenance window execution that is already in progress and cancels -// any tasks in the window that have not already starting running. (Tasks already -// in progress will continue to completion.) +// any tasks in the window that haven't already starting running. Tasks already +// in progress will continue to completion. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -384,11 +398,11 @@ func (c *SSM) CancelMaintenanceWindowExecutionRequest(input *CancelMaintenanceWi // // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CancelMaintenanceWindowExecution func (c *SSM) CancelMaintenanceWindowExecution(input *CancelMaintenanceWindowExecutionInput) (*CancelMaintenanceWindowExecutionOutput, error) { @@ -457,16 +471,18 @@ func (c *SSM) CreateActivationRequest(input *CreateActivationInput) (req *reques // CreateActivation API operation for Amazon Simple Systems Manager (SSM). // // Generates an activation code and activation ID you can use to register your -// on-premises server or virtual machine (VM) with Systems Manager. Registering -// these machines with Systems Manager makes it possible to manage them using -// Systems Manager capabilities. You use the activation code and ID when installing -// SSM Agent on machines in your hybrid environment. For more information about -// requirements for managing on-premises instances and VMs using Systems Manager, -// see Setting up AWS Systems Manager for hybrid environments (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) -// in the AWS Systems Manager User Guide. -// -// On-premises servers or VMs that are registered with Systems Manager and EC2 -// instances that you manage with Systems Manager are all called managed instances. +// on-premises server or virtual machine (VM) with Amazon Web Services Systems +// Manager. Registering these machines with Systems Manager makes it possible +// to manage them using Systems Manager capabilities. You use the activation +// code and ID when installing SSM Agent on machines in your hybrid environment. +// For more information about requirements for managing on-premises instances +// and VMs using Systems Manager, see Setting up Amazon Web Services Systems +// Manager for hybrid environments (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) +// in the Amazon Web Services Systems Manager User Guide. +// +// On-premises servers or VMs that are registered with Systems Manager and Amazon +// Elastic Compute Cloud (Amazon EC2) instances that you manage with Systems +// Manager are all called managed instances. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -549,14 +565,15 @@ func (c *SSM) CreateAssociationRequest(input *CreateAssociationInput) (req *requ // your instances. For example, an association can specify that anti-virus software // must be installed and running on your instances, or that certain ports must // be closed. For static targets, the association specifies a schedule for when -// the configuration is reapplied. For dynamic targets, such as an AWS Resource -// Group or an AWS Autoscaling Group, State Manager applies the configuration -// when new instances are added to the group. The association also specifies -// actions to take when applying the configuration. For example, an association -// for anti-virus software might run once a day. If the software is not installed, -// then State Manager installs it. If the software is installed, but the service -// is not running, then the association might instruct State Manager to start -// the service. +// the configuration is reapplied. For dynamic targets, such as an Amazon Web +// Services resource group or an Amazon Web Services autoscaling group, State +// Manager, a capability of Amazon Web Services Systems Manager applies the +// configuration when new instances are added to the group. The association +// also specifies actions to take when applying the configuration. For example, +// an association for anti-virus software might run once a day. If the software +// isn't installed, then State Manager installs it. If the software is installed, +// but the service isn't running, then the association might instruct State +// Manager to start the service. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -576,38 +593,40 @@ func (c *SSM) CreateAssociationRequest(input *CreateAssociationInput) (req *requ // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidDocumentVersion -// The document version is not valid or does not exist. +// The document version isn't valid or doesn't exist. // // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * UnsupportedPlatformType -// The document does not support the platform type of the given instance ID(s). +// The document doesn't support the platform type of the given instance ID(s). // For example, you sent an document for a Windows instance to a Linux instance. // // * InvalidOutputLocation -// The output location is not valid or does not exist. +// The output location isn't valid or doesn't exist. // // * InvalidParameters -// You must specify values for all required parameters in the Systems Manager -// document. You can only supply values to parameters defined in the Systems -// Manager document. +// You must specify values for all required parameters in the Amazon Web Services +// Systems Manager document (SSM document). You can only supply values to parameters +// defined in the SSM document. // // * InvalidTarget -// The target is not valid or does not exist. It might not be configured for -// Systems Manager or you might not have permission to perform the operation. +// The target isn't valid or doesn't exist. It might not be configured for Systems +// Manager or you might not have permission to perform the operation. // // * InvalidSchedule // The schedule is invalid. Verify your cron or rate expression and try again. @@ -678,12 +697,12 @@ func (c *SSM) CreateAssociationBatchRequest(input *CreateAssociationBatchInput) // CreateAssociationBatch API operation for Amazon Simple Systems Manager (SSM). // -// Associates the specified Systems Manager document with the specified instances -// or targets. +// Associates the specified Amazon Web Services Systems Manager document (SSM +// document) with the specified instances or targets. // // When you associate a document with one or more instances using instance IDs -// or tags, SSM Agent running on the instance processes the document and configures -// the instance as specified. +// or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on +// the instance processes the document and configures the instance as specified. // // If you associate a document with an instance that already has an associated // document, the system returns the AssociationAlreadyExists exception. @@ -700,44 +719,46 @@ func (c *SSM) CreateAssociationBatchRequest(input *CreateAssociationBatchInput) // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidDocumentVersion -// The document version is not valid or does not exist. +// The document version isn't valid or doesn't exist. // // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidParameters -// You must specify values for all required parameters in the Systems Manager -// document. You can only supply values to parameters defined in the Systems -// Manager document. +// You must specify values for all required parameters in the Amazon Web Services +// Systems Manager document (SSM document). You can only supply values to parameters +// defined in the SSM document. // // * DuplicateInstanceId -// You cannot specify an instance ID in more than one association. +// You can't specify an instance ID in more than one association. // // * AssociationLimitExceeded // You can have at most 2,000 active associations. // // * UnsupportedPlatformType -// The document does not support the platform type of the given instance ID(s). +// The document doesn't support the platform type of the given instance ID(s). // For example, you sent an document for a Windows instance to a Linux instance. // // * InvalidOutputLocation -// The output location is not valid or does not exist. +// The output location isn't valid or doesn't exist. // // * InvalidTarget -// The target is not valid or does not exist. It might not be configured for -// Systems Manager or you might not have permission to perform the operation. +// The target isn't valid or doesn't exist. It might not be configured for Systems +// Manager or you might not have permission to perform the operation. // // * InvalidSchedule // The schedule is invalid. Verify your cron or rate expression and try again. @@ -808,11 +829,12 @@ func (c *SSM) CreateDocumentRequest(input *CreateDocumentInput) (req *request.Re // CreateDocument API operation for Amazon Simple Systems Manager (SSM). // -// Creates a Systems Manager (SSM) document. An SSM document defines the actions -// that Systems Manager performs on your managed instances. For more information -// about SSM documents, including information about supported schemas, features, -// and syntax, see AWS Systems Manager Documents (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html) -// in the AWS Systems Manager User Guide. +// Creates a Amazon Web Services Systems Manager (SSM document). An SSM document +// defines the actions that Systems Manager performs on your managed instances. +// For more information about SSM documents, including information about supported +// schemas, features, and syntax, see Amazon Web Services Systems Manager Documents +// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html) +// in the Amazon Web Services Systems Manager User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -832,13 +854,13 @@ func (c *SSM) CreateDocumentRequest(input *CreateDocumentInput) (req *request.Re // An error occurred on the server side. // // * InvalidDocumentContent -// The content for the document is not valid. +// The content for the document isn't valid. // // * DocumentLimitExceeded -// You can have at most 500 active Systems Manager documents. +// You can have at most 500 active SSM documents. // // * InvalidDocumentSchemaVersion -// The version of the document schema is not supported. +// The version of the document schema isn't supported. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateDocument func (c *SSM) CreateDocument(input *CreateDocumentInput) (*CreateDocumentOutput, error) { @@ -932,8 +954,8 @@ func (c *SSM) CreateMaintenanceWindowRequest(input *CreateMaintenanceWindowInput // For example, too many maintenance windows or patch baselines have been created. // // For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -1004,16 +1026,16 @@ func (c *SSM) CreateOpsItemRequest(input *CreateOpsItemInput) (req *request.Requ // CreateOpsItem API operation for Amazon Simple Systems Manager (SSM). // -// Creates a new OpsItem. You must have permission in AWS Identity and Access -// Management (IAM) to create a new OpsItem. For more information, see Getting -// started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) -// in the AWS Systems Manager User Guide. +// Creates a new OpsItem. You must have permission in Identity and Access Management +// (IAM) to create a new OpsItem. For more information, see Getting started +// with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) +// in the Amazon Web Services Systems Manager User Guide. // -// Operations engineers and IT professionals use OpsCenter to view, investigate, -// and remediate operational issues impacting the performance and health of -// their AWS resources. For more information, see AWS Systems Manager OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) -// in the AWS Systems Manager User Guide. +// Operations engineers and IT professionals use Amazon Web Services Systems +// Manager OpsCenter to view, investigate, and remediate operational issues +// impacting the performance and health of their Amazon Web Services resources. +// For more information, see Amazon Web Services Systems Manager OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) +// in the Amazon Web Services Systems Manager User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1103,9 +1125,9 @@ func (c *SSM) CreateOpsMetadataRequest(input *CreateOpsMetadataInput) (req *requ // CreateOpsMetadata API operation for Amazon Simple Systems Manager (SSM). // -// If you create a new application in Application Manager, Systems Manager calls -// this API action to specify information about the new application, including -// the application type. +// If you create a new application in Application Manager, Amazon Web Services +// Systems Manager calls this API operation to specify information about the +// new application, including the application type. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1201,8 +1223,8 @@ func (c *SSM) CreatePatchBaselineRequest(input *CreatePatchBaselineInput) (req * // // Creates a patch baseline. // -// For information about valid key and value pairs in PatchFilters for each -// supported operating system type, see PatchFilter (http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html). +// For information about valid key-value pairs in PatchFilters for each supported +// operating system type, see PatchFilter. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1221,8 +1243,8 @@ func (c *SSM) CreatePatchBaselineRequest(input *CreatePatchBaselineInput) (req * // For example, too many maintenance windows or patch baselines have been created. // // For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -1295,28 +1317,28 @@ func (c *SSM) CreateResourceDataSyncRequest(input *CreateResourceDataSyncInput) // CreateResourceDataSync API operation for Amazon Simple Systems Manager (SSM). // // A resource data sync helps you view data from multiple sources in a single -// location. Systems Manager offers two types of resource data sync: SyncToDestination -// and SyncFromSource. +// location. Amazon Web Services Systems Manager offers two types of resource +// data sync: SyncToDestination and SyncFromSource. // // You can configure Systems Manager Inventory to use the SyncToDestination -// type to synchronize Inventory data from multiple AWS Regions to a single -// S3 bucket. For more information, see Configuring Resource Data Sync for Inventory -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html) -// in the AWS Systems Manager User Guide. +// type to synchronize Inventory data from multiple Regions to a single Amazon +// Simple Storage Service (Amazon S3) bucket. For more information, see Configuring +// resource data sync for Inventory (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html) +// in the Amazon Web Services Systems Manager User Guide. // // You can configure Systems Manager Explorer to use the SyncFromSource type // to synchronize operational work items (OpsItems) and operational data (OpsData) -// from multiple AWS Regions to a single S3 bucket. This type can synchronize -// OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization -// by using AWS Organizations. For more information, see Setting up Systems -// Manager Explorer to display data from multiple accounts and Regions (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) -// in the AWS Systems Manager User Guide. +// from multiple Regions to a single Amazon S3 bucket. This type can synchronize +// OpsItems and OpsData from multiple accounts and Regions or EntireOrganization +// by using Organizations. For more information, see Setting up Systems Manager +// Explorer to display data from multiple accounts and Regions (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) +// in the Amazon Web Services Systems Manager User Guide. // // A resource data sync is an asynchronous operation that returns immediately. // After a successful initial sync is completed, the system continuously syncs // data. To check the status of a sync, use the ListResourceDataSync. // -// By default, data is not encrypted in Amazon S3. We strongly recommend that +// By default, data isn't encrypted in Amazon S3. We strongly recommend that // you enable encryption in Amazon S3 to ensure secure data storage. We also // recommend that you secure access to the Amazon S3 bucket by creating a restrictive // bucket policy. @@ -1408,9 +1430,9 @@ func (c *SSM) DeleteActivationRequest(input *DeleteActivationInput) (req *reques // DeleteActivation API operation for Amazon Simple Systems Manager (SSM). // -// Deletes an activation. You are not required to delete an activation. If you +// Deletes an activation. You aren't required to delete an activation. If you // delete an activation, you can no longer use it to register additional managed -// instances. Deleting an activation does not de-register managed instances. +// instances. Deleting an activation doesn't de-register managed instances. // You must manually de-register managed instances. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1422,12 +1444,12 @@ func (c *SSM) DeleteActivationRequest(input *DeleteActivationInput) (req *reques // // Returned Error Types: // * InvalidActivationId -// The activation ID is not valid. Verify the you entered the correct ActivationId +// The activation ID isn't valid. Verify the you entered the correct ActivationId // or ActivationCode and try again. // // * InvalidActivation -// The activation is not valid. The activation might have been deleted, or the -// ActivationId and the ActivationCode do not match. +// The activation isn't valid. The activation might have been deleted, or the +// ActivationId and the ActivationCode don't match. // // * InternalServerError // An error occurred on the server side. @@ -1503,9 +1525,10 @@ func (c *SSM) DeleteAssociationRequest(input *DeleteAssociationInput) (req *requ // DeleteAssociation API operation for Amazon Simple Systems Manager (SSM). // -// Disassociates the specified Systems Manager document from the specified instance. +// Disassociates the specified Amazon Web Services Systems Manager document +// (SSM document) from the specified instance. // -// When you disassociate a document from an instance, it does not change the +// When you disassociate a document from an instance, it doesn't change the // configuration of the instance. To change the configuration state of an instance // after you disassociate a document, you must create a new document with the // desired configuration and associate it with the instance. @@ -1519,25 +1542,27 @@ func (c *SSM) DeleteAssociationRequest(input *DeleteAssociationInput) (req *requ // // Returned Error Types: // * AssociationDoesNotExist -// The specified association does not exist. +// The specified association doesn't exist. // // * InternalServerError // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * TooManyUpdates // There are concurrent updates for a resource that supports one update at a @@ -1610,8 +1635,8 @@ func (c *SSM) DeleteDocumentRequest(input *DeleteDocumentInput) (req *request.Re // DeleteDocument API operation for Amazon Simple Systems Manager (SSM). // -// Deletes the Systems Manager document and all instance associations to the -// document. +// Deletes the Amazon Web Services Systems Manager document (SSM document) and +// all instance associations to the document. // // Before you delete the document, we recommend that you use DeleteAssociation // to disassociate all instances that are associated with the document. @@ -1628,7 +1653,7 @@ func (c *SSM) DeleteDocumentRequest(input *DeleteDocumentInput) (req *request.Re // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidDocumentOperation // You attempted to delete a document while it is still shared. You must stop @@ -1720,18 +1745,18 @@ func (c *SSM) DeleteInventoryRequest(input *DeleteInventoryInput) (req *request. // An error occurred on the server side. // // * InvalidTypeNameException -// The parameter type name is not valid. +// The parameter type name isn't valid. // // * InvalidOptionException -// The delete inventory option specified is not valid. Verify the option and +// The delete inventory option specified isn't valid. Verify the option and // try again. // // * InvalidDeleteInventoryParametersException -// One or more of the parameters specified for the delete operation is not valid. +// One or more of the parameters specified for the delete operation isn't valid. // Verify all parameters and try again. // // * InvalidInventoryRequestException -// The request is not valid. +// The request isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteInventory func (c *SSM) DeleteInventory(input *DeleteInventoryInput) (*DeleteInventoryOutput, error) { @@ -1890,7 +1915,7 @@ func (c *SSM) DeleteOpsMetadataRequest(input *DeleteOpsMetadataInput) (req *requ // // Returned Error Types: // * OpsMetadataNotFoundException -// The OpsMetadata object does not exist. +// The OpsMetadata object doesn't exist. // // * OpsMetadataInvalidArgumentException // One of the arguments passed is invalid. @@ -1979,7 +2004,7 @@ func (c *SSM) DeleteParameterRequest(input *DeleteParameterInput) (req *request. // An error occurred on the server side. // // * ParameterNotFound -// The parameter could not be found. Verify the name and try again. +// The parameter couldn't be found. Verify the name and try again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteParameter func (c *SSM) DeleteParameter(input *DeleteParameterInput) (*DeleteParameterOutput, error) { @@ -2210,9 +2235,9 @@ func (c *SSM) DeleteResourceDataSyncRequest(input *DeleteResourceDataSyncInput) // DeleteResourceDataSync API operation for Amazon Simple Systems Manager (SSM). // -// Deletes a Resource Data Sync configuration. After the configuration is deleted, +// Deletes a resource data sync configuration. After the configuration is deleted, // changes to data on managed instances are no longer synced to or from the -// target. Deleting a sync configuration does not delete data. +// target. Deleting a sync configuration doesn't delete data. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2226,7 +2251,7 @@ func (c *SSM) DeleteResourceDataSyncRequest(input *DeleteResourceDataSyncInput) // An error occurred on the server side. // // * ResourceDataSyncNotFoundException -// The specified sync name was not found. +// The specified sync name wasn't found. // // * ResourceDataSyncInvalidConfigurationException // The specified sync configuration is invalid. @@ -2313,14 +2338,16 @@ func (c *SSM) DeregisterManagedInstanceRequest(input *DeregisterManagedInstanceI // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InternalServerError // An error occurred on the server side. @@ -2402,8 +2429,8 @@ func (c *SSM) DeregisterPatchBaselineForPatchGroupRequest(input *DeregisterPatch // // Returned Error Types: // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // * InternalServerError // An error occurred on the server side. @@ -2486,11 +2513,11 @@ func (c *SSM) DeregisterTargetFromMaintenanceWindowRequest(input *DeregisterTarg // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -2577,11 +2604,11 @@ func (c *SSM) DeregisterTaskFromMaintenanceWindowRequest(input *DeregisterTaskFr // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -2659,8 +2686,9 @@ func (c *SSM) DescribeActivationsRequest(input *DescribeActivationsInput) (req * // DescribeActivations API operation for Amazon Simple Systems Manager (SSM). // // Describes details about the activation, such as the date and time the activation -// was created, its expiration date, the IAM role assigned to the instances -// in the activation, and the number of instances registered by using this activation. +// was created, its expiration date, the Identity and Access Management (IAM) +// role assigned to the instances in the activation, and the number of instances +// registered by using this activation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2671,11 +2699,11 @@ func (c *SSM) DescribeActivationsRequest(input *DescribeActivationsInput) (req * // // Returned Error Types: // * InvalidFilter -// The filter name is not valid. Verify the you entered the correct name and +// The filter name isn't valid. Verify the you entered the correct name and // try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InternalServerError // An error occurred on the server side. @@ -2801,8 +2829,9 @@ func (c *SSM) DescribeAssociationRequest(input *DescribeAssociationInput) (req * // Describes the association for the specified target or instance. If you created // the association by using the Targets parameter, then you must retrieve the // association by using the association ID. If you created the association by -// specifying an instance ID and a Systems Manager document, then you retrieve -// the association by specifying the document name and the instance ID. +// specifying an instance ID and an Amazon Web Services Systems Manager document +// (SSM document), then you retrieve the association by specifying the document +// name and the instance ID. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2813,10 +2842,10 @@ func (c *SSM) DescribeAssociationRequest(input *DescribeAssociationInput) (req * // // Returned Error Types: // * AssociationDoesNotExist -// The specified association does not exist. +// The specified association doesn't exist. // // * InvalidAssociationVersion -// The version you specified is not valid. Use ListAssociationVersions to view +// The version you specified isn't valid. Use ListAssociationVersions to view // all versions of an association according to the association ID. Or, use the // $LATEST parameter to view the latest version of the association. // @@ -2824,19 +2853,21 @@ func (c *SSM) DescribeAssociationRequest(input *DescribeAssociationInput) (req * // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociation func (c *SSM) DescribeAssociation(input *DescribeAssociationInput) (*DescribeAssociationOutput, error) { @@ -2910,8 +2941,7 @@ func (c *SSM) DescribeAssociationExecutionTargetsRequest(input *DescribeAssociat // DescribeAssociationExecutionTargets API operation for Amazon Simple Systems Manager (SSM). // -// Use this API action to view information about a specific execution of a specific -// association. +// Views information about a specific execution of a specific association. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2925,13 +2955,13 @@ func (c *SSM) DescribeAssociationExecutionTargetsRequest(input *DescribeAssociat // An error occurred on the server side. // // * AssociationDoesNotExist -// The specified association does not exist. +// The specified association doesn't exist. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * AssociationExecutionDoesNotExist -// The specified execution ID does not exist. Verify the ID number and try again. +// The specified execution ID doesn't exist. Verify the ID number and try again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociationExecutionTargets func (c *SSM) DescribeAssociationExecutionTargets(input *DescribeAssociationExecutionTargetsInput) (*DescribeAssociationExecutionTargetsOutput, error) { @@ -3057,7 +3087,7 @@ func (c *SSM) DescribeAssociationExecutionsRequest(input *DescribeAssociationExe // DescribeAssociationExecutions API operation for Amazon Simple Systems Manager (SSM). // -// Use this API action to view all executions for a specific association ID. +// Views all executions for a specific association ID. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3071,10 +3101,10 @@ func (c *SSM) DescribeAssociationExecutionsRequest(input *DescribeAssociationExe // An error occurred on the server side. // // * AssociationDoesNotExist -// The specified association does not exist. +// The specified association doesn't exist. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociationExecutions func (c *SSM) DescribeAssociationExecutions(input *DescribeAssociationExecutionsInput) (*DescribeAssociationExecutionsOutput, error) { @@ -3211,13 +3241,13 @@ func (c *SSM) DescribeAutomationExecutionsRequest(input *DescribeAutomationExecu // // Returned Error Types: // * InvalidFilterKey -// The specified key is not valid. +// The specified key isn't valid. // // * InvalidFilterValue -// The filter value is not valid. Verify the value and try again. +// The filter value isn't valid. Verify the value and try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InternalServerError // An error occurred on the server side. @@ -3362,13 +3392,13 @@ func (c *SSM) DescribeAutomationStepExecutionsRequest(input *DescribeAutomationS // execution ID. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InvalidFilterKey -// The specified key is not valid. +// The specified key isn't valid. // // * InvalidFilterValue -// The filter value is not valid. Verify the value and try again. +// The filter value isn't valid. Verify the value and try again. // // * InternalServerError // An error occurred on the server side. @@ -3628,7 +3658,8 @@ func (c *SSM) DescribeDocumentRequest(input *DescribeDocumentInput) (req *reques // DescribeDocument API operation for Amazon Simple Systems Manager (SSM). // -// Describes the specified Systems Manager document. +// Describes the specified Amazon Web Services Systems Manager document (SSM +// document). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3642,10 +3673,10 @@ func (c *SSM) DescribeDocumentRequest(input *DescribeDocumentInput) (req *reques // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidDocumentVersion -// The document version is not valid or does not exist. +// The document version isn't valid or doesn't exist. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeDocument func (c *SSM) DescribeDocument(input *DescribeDocumentInput) (*DescribeDocumentOutput, error) { @@ -3713,9 +3744,10 @@ func (c *SSM) DescribeDocumentPermissionRequest(input *DescribeDocumentPermissio // DescribeDocumentPermission API operation for Amazon Simple Systems Manager (SSM). // -// Describes the permissions for a Systems Manager document. If you created -// the document, you are the owner. If a document is shared, it can either be -// shared privately (by specifying a user's AWS account ID) or publicly (All). +// Describes the permissions for a Amazon Web Services Systems Manager document +// (SSM document). If you created the document, you are the owner. If a document +// is shared, it can either be shared privately (by specifying a user's account +// ID) or publicly (All). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3729,13 +3761,13 @@ func (c *SSM) DescribeDocumentPermissionRequest(input *DescribeDocumentPermissio // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InvalidPermissionType -// The permission type is not supported. Share is the only supported permission +// The permission type isn't supported. Share is the only supported permission // type. // // * InvalidDocumentOperation @@ -3830,17 +3862,19 @@ func (c *SSM) DescribeEffectiveInstanceAssociationsRequest(input *DescribeEffect // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeEffectiveInstanceAssociations func (c *SSM) DescribeEffectiveInstanceAssociations(input *DescribeEffectiveInstanceAssociationsInput) (*DescribeEffectiveInstanceAssociationsOutput, error) { @@ -3967,8 +4001,8 @@ func (c *SSM) DescribeEffectivePatchesForPatchBaselineRequest(input *DescribeEff // DescribeEffectivePatchesForPatchBaseline API operation for Amazon Simple Systems Manager (SSM). // // Retrieves the current effective patches (the patch and the approval state) -// for the specified patch baseline. Note that this API applies only to Windows -// patch baselines. +// for the specified patch baseline. Applies to patch baselines for Windows +// only. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3979,20 +4013,20 @@ func (c *SSM) DescribeEffectivePatchesForPatchBaselineRequest(input *DescribeEff // // Returned Error Types: // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * UnsupportedOperatingSystem -// The operating systems you specified is not supported, or the operation is -// not supported for the operating system. +// The operating systems you specified isn't supported, or the operation isn't +// supported for the operating system. // // * InternalServerError // An error occurred on the server side. @@ -4137,17 +4171,19 @@ func (c *SSM) DescribeInstanceAssociationsStatusRequest(input *DescribeInstanceA // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstanceAssociationsStatus func (c *SSM) DescribeInstanceAssociationsStatus(input *DescribeInstanceAssociationsStatusInput) (*DescribeInstanceAssociationsStatusOutput, error) { @@ -4278,12 +4314,12 @@ func (c *SSM) DescribeInstanceInformationRequest(input *DescribeInstanceInformat // instance status, and so on. // // If you specify one or more instance IDs, it returns information for those -// instances. If you do not specify instance IDs, it returns information for -// all your instances. If you specify an instance ID that is not valid or an -// instance that you do not own, you receive an error. +// instances. If you don't specify instance IDs, it returns information for +// all your instances. If you specify an instance ID that isn't valid or an +// instance that you don't own, you receive an error. // -// The IamRole field for this API action is the Amazon Identity and Access Management -// (IAM) role assigned to on-premises instances. This call does not return the +// The IamRole field for this API operation is the Identity and Access Management +// (IAM) role assigned to on-premises instances. This call doesn't return the // IAM role for EC2 instances. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4300,23 +4336,25 @@ func (c *SSM) DescribeInstanceInformationRequest(input *DescribeInstanceInformat // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InvalidInstanceInformationFilterValue -// The specified filter value is not valid. +// The specified filter value isn't valid. // // * InvalidFilterKey -// The specified key is not valid. +// The specified key isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstanceInformation func (c *SSM) DescribeInstanceInformation(input *DescribeInstanceInformationInput) (*DescribeInstanceInformationOutput, error) { @@ -4456,7 +4494,7 @@ func (c *SSM) DescribeInstancePatchStatesRequest(input *DescribeInstancePatchSta // An error occurred on the server side. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatchStates func (c *SSM) DescribeInstancePatchStates(input *DescribeInstancePatchStatesInput) (*DescribeInstancePatchStatesOutput, error) { @@ -4597,11 +4635,11 @@ func (c *SSM) DescribeInstancePatchStatesForPatchGroupRequest(input *DescribeIns // An error occurred on the server side. // // * InvalidFilter -// The filter name is not valid. Verify the you entered the correct name and +// The filter name isn't valid. Verify the you entered the correct name and // try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup func (c *SSM) DescribeInstancePatchStatesForPatchGroup(input *DescribeInstancePatchStatesForPatchGroupInput) (*DescribeInstancePatchStatesForPatchGroupOutput, error) { @@ -4744,21 +4782,23 @@ func (c *SSM) DescribeInstancePatchesRequest(input *DescribeInstancePatchesInput // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidFilter -// The filter name is not valid. Verify the you entered the correct name and +// The filter name isn't valid. Verify the you entered the correct name and // try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatches func (c *SSM) DescribeInstancePatches(input *DescribeInstancePatchesInput) (*DescribeInstancePatchesOutput, error) { @@ -4898,11 +4938,11 @@ func (c *SSM) DescribeInventoryDeletionsRequest(input *DescribeInventoryDeletion // An error occurred on the server side. // // * InvalidDeletionIdException -// The ID specified for the delete operation does not exist or is not valid. -// Verify the ID and try again. +// The ID specified for the delete operation doesn't exist or isn't valid. Verify +// the ID and try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInventoryDeletions func (c *SSM) DescribeInventoryDeletions(input *DescribeInventoryDeletionsInput) (*DescribeInventoryDeletionsOutput, error) { @@ -5041,11 +5081,11 @@ func (c *SSM) DescribeMaintenanceWindowExecutionTaskInvocationsRequest(input *De // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -5186,11 +5226,11 @@ func (c *SSM) DescribeMaintenanceWindowExecutionTasksRequest(input *DescribeMain // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -5473,11 +5513,11 @@ func (c *SSM) DescribeMaintenanceWindowScheduleRequest(input *DescribeMaintenanc // // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowSchedule func (c *SSM) DescribeMaintenanceWindowSchedule(input *DescribeMaintenanceWindowScheduleInput) (*DescribeMaintenanceWindowScheduleOutput, error) { @@ -5615,11 +5655,11 @@ func (c *SSM) DescribeMaintenanceWindowTargetsRequest(input *DescribeMaintenance // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -5750,10 +5790,10 @@ func (c *SSM) DescribeMaintenanceWindowTasksRequest(input *DescribeMaintenanceWi // // Lists the tasks in a maintenance window. // -// For maintenance window tasks without a specified target, you cannot supply +// For maintenance window tasks without a specified target, you can't supply // values for --max-errors and --max-concurrency. Instead, the system inserts // a placeholder value of 1, which may be reported in the response to this command. -// These values do not affect the running of your task and can be ignored. +// These values don't affect the running of your task and can be ignored. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5765,11 +5805,11 @@ func (c *SSM) DescribeMaintenanceWindowTasksRequest(input *DescribeMaintenanceWi // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -5898,7 +5938,7 @@ func (c *SSM) DescribeMaintenanceWindowsRequest(input *DescribeMaintenanceWindow // DescribeMaintenanceWindows API operation for Amazon Simple Systems Manager (SSM). // -// Retrieves the maintenance windows in an AWS account. +// Retrieves the maintenance windows in an account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6173,16 +6213,16 @@ func (c *SSM) DescribeOpsItemsRequest(input *DescribeOpsItemsInput) (req *reques // DescribeOpsItems API operation for Amazon Simple Systems Manager (SSM). // -// Query a set of OpsItems. You must have permission in AWS Identity and Access +// Query a set of OpsItems. You must have permission in Identity and Access // Management (IAM) to query a list of OpsItems. For more information, see Getting // started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) -// in the AWS Systems Manager User Guide. +// in the Amazon Web Services Systems Manager User Guide. // -// Operations engineers and IT professionals use OpsCenter to view, investigate, -// and remediate operational issues impacting the performance and health of -// their AWS resources. For more information, see AWS Systems Manager OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) -// in the AWS Systems Manager User Guide. +// Operations engineers and IT professionals use Amazon Web Services Systems +// Manager OpsCenter to view, investigate, and remediate operational issues +// impacting the performance and health of their Amazon Web Services resources. +// For more information, see OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) +// in the Amazon Web Services Systems Manager User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6341,17 +6381,17 @@ func (c *SSM) DescribeParametersRequest(input *DescribeParametersInput) (req *re // An error occurred on the server side. // // * InvalidFilterKey -// The specified key is not valid. +// The specified key isn't valid. // // * InvalidFilterOption -// The specified filter option is not valid. Valid options are Equals and BeginsWith. +// The specified filter option isn't valid. Valid options are Equals and BeginsWith. // For Path filter, valid options are Recursive and OneLevel. // // * InvalidFilterValue -// The filter value is not valid. Verify the value and try again. +// The filter value isn't valid. Verify the value and try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeParameters func (c *SSM) DescribeParameters(input *DescribeParametersInput) (*DescribeParametersOutput, error) { @@ -6477,7 +6517,7 @@ func (c *SSM) DescribePatchBaselinesRequest(input *DescribePatchBaselinesInput) // DescribePatchBaselines API operation for Amazon Simple Systems Manager (SSM). // -// Lists the patch baselines in your AWS account. +// Lists the patch baselines in your account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6608,7 +6648,8 @@ func (c *SSM) DescribePatchGroupStateRequest(input *DescribePatchGroupStateInput // DescribePatchGroupState API operation for Amazon Simple Systems Manager (SSM). // -// Returns high-level aggregated patch compliance state for a patch group. +// Returns high-level aggregated patch compliance state information for a patch +// group. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6622,7 +6663,7 @@ func (c *SSM) DescribePatchGroupStateRequest(input *DescribePatchGroupStateInput // An error occurred on the server side. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchGroupState func (c *SSM) DescribePatchGroupState(input *DescribePatchGroupStateInput) (*DescribePatchGroupStateOutput, error) { @@ -6836,7 +6877,7 @@ func (c *SSM) DescribePatchPropertiesRequest(input *DescribePatchPropertiesInput // Lists the properties of available patches organized by product, product family, // classification, severity, and other properties of available patches. You // can use the reported properties in the filters you specify in requests for -// actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, +// operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, // and DescribePatchBaselines. // // The following section lists the properties that can be used in filters for @@ -6844,43 +6885,43 @@ func (c *SSM) DescribePatchPropertiesRequest(input *DescribePatchPropertiesInput // // AMAZON_LINUX // -// Valid properties: PRODUCT, CLASSIFICATION, SEVERITY +// Valid properties: PRODUCT | CLASSIFICATION | SEVERITY // // AMAZON_LINUX_2 // -// Valid properties: PRODUCT, CLASSIFICATION, SEVERITY +// Valid properties: PRODUCT | CLASSIFICATION | SEVERITY // // CENTOS // -// Valid properties: PRODUCT, CLASSIFICATION, SEVERITY +// Valid properties: PRODUCT | CLASSIFICATION | SEVERITY // // DEBIAN // -// Valid properties: PRODUCT, PRIORITY +// Valid properties: PRODUCT | PRIORITY // // MACOS // -// Valid properties: PRODUCT, CLASSIFICATION +// Valid properties: PRODUCT | CLASSIFICATION // // ORACLE_LINUX // -// Valid properties: PRODUCT, CLASSIFICATION, SEVERITY +// Valid properties: PRODUCT | CLASSIFICATION | SEVERITY // // REDHAT_ENTERPRISE_LINUX // -// Valid properties: PRODUCT, CLASSIFICATION, SEVERITY +// Valid properties: PRODUCT | CLASSIFICATION | SEVERITY // // SUSE // -// Valid properties: PRODUCT, CLASSIFICATION, SEVERITY +// Valid properties: PRODUCT | CLASSIFICATION | SEVERITY // // UBUNTU // -// Valid properties: PRODUCT, PRIORITY +// Valid properties: PRODUCT | PRIORITY // // WINDOWS // -// Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY +// Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7032,10 +7073,10 @@ func (c *SSM) DescribeSessionsRequest(input *DescribeSessionsInput) (req *reques // An error occurred on the server side. // // * InvalidFilterKey -// The specified key is not valid. +// The specified key isn't valid. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeSessions func (c *SSM) DescribeSessions(input *DescribeSessionsInput) (*DescribeSessionsOutput, error) { @@ -7157,8 +7198,8 @@ func (c *SSM) DisassociateOpsItemRelatedItemRequest(input *DisassociateOpsItemRe // DisassociateOpsItemRelatedItem API operation for Amazon Simple Systems Manager (SSM). // // Deletes the association between an OpsItem and a related resource. For example, -// this API action can delete an Incident Manager incident from an OpsItem. -// Incident Manager is a capability of AWS Systems Manager. +// this API operation can delete an Incident Manager incident from an OpsItem. +// Incident Manager is a capability of Amazon Web Services Systems Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7172,7 +7213,7 @@ func (c *SSM) DisassociateOpsItemRelatedItemRequest(input *DisassociateOpsItemRe // An error occurred on the server side. // // * OpsItemRelatedItemAssociationNotFoundException -// The association was not found using the parameters you specified in the call. +// The association wasn't found using the parameters you specified in the call. // Verify the information and try again. // // * OpsItemNotFoundException @@ -7331,20 +7372,21 @@ func (c *SSM) GetCalendarStateRequest(input *GetCalendarStateInput) (req *reques // GetCalendarState API operation for Amazon Simple Systems Manager (SSM). // -// Gets the state of the AWS Systems Manager Change Calendar at an optional, -// specified time. If you specify a time, GetCalendarState returns the state -// of the calendar at a specific time, and returns the next time that the Change -// Calendar state will transition. If you do not specify a time, GetCalendarState -// assumes the current time. Change Calendar entries have two possible states: -// OPEN or CLOSED. +// Gets the state of a Amazon Web Services Systems Manager change calendar at +// the current time or a specified time. If you specify a time, GetCalendarState +// returns the state of the calendar at that specific time, and returns the +// next time that the change calendar state will transition. If you don't specify +// a time, GetCalendarState uses the current time. Change Calendar entries have +// two possible states: OPEN or CLOSED. // // If you specify more than one calendar in a request, the command returns the // status of OPEN only if all calendars in the request are open. If one or more // calendars in the request are closed, the status returned is CLOSED. // -// For more information about Systems Manager Change Calendar, see AWS Systems -// Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html) -// in the AWS Systems Manager User Guide. +// For more information about Change Calendar, a capability of Amazon Web Services +// Systems Manager, see Amazon Web Services Systems Manager Change Calendar +// (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html) +// in the Amazon Web Services Systems Manager User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7358,15 +7400,14 @@ func (c *SSM) GetCalendarStateRequest(input *GetCalendarStateInput) (req *reques // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidDocumentType -// The document type is not valid. Valid document types are described in the -// DocumentType property. +// The SSM document type isn't valid. Valid document types are described in +// the DocumentType property. // // * UnsupportedCalendarException -// The calendar entry contained in the specified Systems Manager document is -// not supported. +// The calendar entry contained in the specified SSM document isn't supported. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetCalendarState func (c *SSM) GetCalendarState(input *GetCalendarStateInput) (*GetCalendarStateOutput, error) { @@ -7453,25 +7494,27 @@ func (c *SSM) GetCommandInvocationRequest(input *GetCommandInvocationInput) (req // An error occurred on the server side. // // * InvalidCommandId -// The specified command ID is not valid. Verify the ID and try again. +// The specified command ID isn't valid. Verify the ID and try again. // // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidPluginName -// The plugin name is not valid. +// The plugin name isn't valid. // // * InvocationDoesNotExist -// The command ID and instance ID you specified did not match any invocations. +// The command ID and instance ID you specified didn't match any invocations. // Verify the command ID and the instance ID and try again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetCommandInvocation @@ -7620,11 +7663,11 @@ func (c *SSM) GetDefaultPatchBaselineRequest(input *GetDefaultPatchBaselineInput // GetDefaultPatchBaseline API operation for Amazon Simple Systems Manager (SSM). // -// Retrieves the default patch baseline. Note that Systems Manager supports -// creating multiple default patch baselines. For example, you can create a -// default patch baseline for each operating system. +// Retrieves the default patch baseline. Amazon Web Services Systems Manager +// supports creating multiple default patch baselines. For example, you can +// create a default patch baseline for each operating system. // -// If you do not specify an operating system value, the default patch baseline +// If you don't specify an operating system value, the default patch baseline // for Windows is returned. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -7705,7 +7748,16 @@ func (c *SSM) GetDeployablePatchSnapshotForInstanceRequest(input *GetDeployableP // GetDeployablePatchSnapshotForInstance API operation for Amazon Simple Systems Manager (SSM). // // Retrieves the current snapshot for the patch baseline the instance uses. -// This API is primarily used by the AWS-RunPatchBaseline Systems Manager document. +// This API is primarily used by the AWS-RunPatchBaseline Systems Manager document +// (SSM document). +// +// If you run the command locally, such as with the Command Line Interface (CLI), +// the system attempts to use your local AWS credentials and the operation fails. +// To avoid this, you can run the command in the Amazon Web Services Systems +// Manager console. Use Run Command, a capability of Amazon Web Services Systems +// Manager, with an SSM document that enables you to target an instance with +// a script or command. For example, run the command using the AWS-RunShellScript +// document or the AWS-RunPowerShellScript document. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7719,15 +7771,15 @@ func (c *SSM) GetDeployablePatchSnapshotForInstanceRequest(input *GetDeployableP // An error occurred on the server side. // // * UnsupportedOperatingSystem -// The operating systems you specified is not supported, or the operation is -// not supported for the operating system. +// The operating systems you specified isn't supported, or the operation isn't +// supported for the operating system. // // * UnsupportedFeatureRequiredException -// Microsoft application patching is only available on EC2 instances and advanced -// instances. To patch Microsoft applications on on-premises servers and VMs, -// you must enable advanced instances. For more information, see Using the advanced-instances -// tier (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html) -// in the AWS Systems Manager User Guide. +// Patching for applications released by Microsoft is only available on EC2 +// instances and advanced instances. To patch applications released by Microsoft +// on on-premises servers and VMs, you must enable advanced instances. For more +// information, see Enabling the advanced-instances tier (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html) +// in the Amazon Web Services Systems Manager User Guide. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance func (c *SSM) GetDeployablePatchSnapshotForInstance(input *GetDeployablePatchSnapshotForInstanceInput) (*GetDeployablePatchSnapshotForInstanceOutput, error) { @@ -7795,7 +7847,8 @@ func (c *SSM) GetDocumentRequest(input *GetDocumentInput) (req *request.Request, // GetDocument API operation for Amazon Simple Systems Manager (SSM). // -// Gets the contents of the specified Systems Manager document. +// Gets the contents of the specified Amazon Web Services Systems Manager document +// (SSM document). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7809,10 +7862,10 @@ func (c *SSM) GetDocumentRequest(input *GetDocumentInput) (req *request.Request, // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidDocumentVersion -// The document version is not valid or does not exist. +// The document version isn't valid or doesn't exist. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDocument func (c *SSM) GetDocument(input *GetDocumentInput) (*GetDocumentOutput, error) { @@ -7900,24 +7953,24 @@ func (c *SSM) GetInventoryRequest(input *GetInventoryInput) (req *request.Reques // An error occurred on the server side. // // * InvalidFilter -// The filter name is not valid. Verify the you entered the correct name and +// The filter name isn't valid. Verify the you entered the correct name and // try again. // // * InvalidInventoryGroupException -// The specified inventory group is not valid. +// The specified inventory group isn't valid. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InvalidTypeNameException -// The parameter type name is not valid. +// The parameter type name isn't valid. // // * InvalidAggregatorException -// The specified aggregator is not valid for inventory groups. Verify that the +// The specified aggregator isn't valid for inventory groups. Verify that the // aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation. // // * InvalidResultAttributeException -// The specified inventory item result attribute is not valid. +// The specified inventory item result attribute isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetInventory func (c *SSM) GetInventory(input *GetInventoryInput) (*GetInventoryOutput, error) { @@ -8058,10 +8111,10 @@ func (c *SSM) GetInventorySchemaRequest(input *GetInventorySchemaInput) (req *re // An error occurred on the server side. // // * InvalidTypeNameException -// The parameter type name is not valid. +// The parameter type name isn't valid. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetInventorySchema func (c *SSM) GetInventorySchema(input *GetInventorySchemaInput) (*GetInventorySchemaOutput, error) { @@ -8193,11 +8246,11 @@ func (c *SSM) GetMaintenanceWindowRequest(input *GetMaintenanceWindowInput) (req // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -8280,11 +8333,11 @@ func (c *SSM) GetMaintenanceWindowExecutionRequest(input *GetMaintenanceWindowEx // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -8368,11 +8421,11 @@ func (c *SSM) GetMaintenanceWindowExecutionTaskRequest(input *GetMaintenanceWind // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -8455,11 +8508,11 @@ func (c *SSM) GetMaintenanceWindowExecutionTaskInvocationRequest(input *GetMaint // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -8532,10 +8585,10 @@ func (c *SSM) GetMaintenanceWindowTaskRequest(input *GetMaintenanceWindowTaskInp // // Lists the tasks in a maintenance window. // -// For maintenance window tasks without a specified target, you cannot supply +// For maintenance window tasks without a specified target, you can't supply // values for --max-errors and --max-concurrency. Instead, the system inserts // a placeholder value of 1, which may be reported in the response to this command. -// These values do not affect the running of your task and can be ignored. +// These values don't affect the running of your task and can be ignored. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8547,11 +8600,11 @@ func (c *SSM) GetMaintenanceWindowTaskRequest(input *GetMaintenanceWindowTaskInp // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -8623,15 +8676,15 @@ func (c *SSM) GetOpsItemRequest(input *GetOpsItemInput) (req *request.Request, o // GetOpsItem API operation for Amazon Simple Systems Manager (SSM). // // Get information about an OpsItem by using the ID. You must have permission -// in AWS Identity and Access Management (IAM) to view information about an -// OpsItem. For more information, see Getting started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) -// in the AWS Systems Manager User Guide. +// in Identity and Access Management (IAM) to view information about an OpsItem. +// For more information, see Getting started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) +// in the Amazon Web Services Systems Manager User Guide. // -// Operations engineers and IT professionals use OpsCenter to view, investigate, -// and remediate operational issues impacting the performance and health of -// their AWS resources. For more information, see AWS Systems Manager OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) -// in the AWS Systems Manager User Guide. +// Operations engineers and IT professionals use Amazon Web Services Systems +// Manager OpsCenter to view, investigate, and remediate operational issues +// impacting the performance and health of their Amazon Web Services resources. +// For more information, see OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) +// in the Amazon Web Services Systems Manager User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8724,7 +8777,7 @@ func (c *SSM) GetOpsMetadataRequest(input *GetOpsMetadataInput) (req *request.Re // // Returned Error Types: // * OpsMetadataNotFoundException -// The OpsMetadata object does not exist. +// The OpsMetadata object doesn't exist. // // * OpsMetadataInvalidArgumentException // One of the arguments passed is invalid. @@ -8804,7 +8857,11 @@ func (c *SSM) GetOpsSummaryRequest(input *GetOpsSummaryInput) (req *request.Requ // GetOpsSummary API operation for Amazon Simple Systems Manager (SSM). // -// View a summary of OpsItems based on specified filters and aggregators. +// View a summary of operations metadata (OpsData) based on specified filters +// and aggregators. OpsData can include information about Amazon Web Services +// Systems Manager OpsCenter operational workitems (OpsItems) as well as information +// about any Amazon Web Services resource or service configured to report OpsData +// to Amazon Web Services Systems Manager Explorer. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8818,20 +8875,20 @@ func (c *SSM) GetOpsSummaryRequest(input *GetOpsSummaryInput) (req *request.Requ // An error occurred on the server side. // // * ResourceDataSyncNotFoundException -// The specified sync name was not found. +// The specified sync name wasn't found. // // * InvalidFilter -// The filter name is not valid. Verify the you entered the correct name and +// The filter name isn't valid. Verify the you entered the correct name and // try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InvalidTypeNameException -// The parameter type name is not valid. +// The parameter type name isn't valid. // // * InvalidAggregatorException -// The specified aggregator is not valid for inventory groups. Verify that the +// The specified aggregator isn't valid for inventory groups. Verify that the // aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsSummary @@ -8953,7 +9010,7 @@ func (c *SSM) GetParameterRequest(input *GetParameterInput) (req *request.Reques // GetParameter API operation for Amazon Simple Systems Manager (SSM). // // Get information about a parameter by using the parameter name. Don't confuse -// this API action with the GetParameters API action. +// this API operation with the GetParameters API operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8967,14 +9024,14 @@ func (c *SSM) GetParameterRequest(input *GetParameterInput) (req *request.Reques // An error occurred on the server side. // // * InvalidKeyId -// The query key ID is not valid. +// The query key ID isn't valid. // // * ParameterNotFound -// The parameter could not be found. Verify the name and try again. +// The parameter couldn't be found. Verify the name and try again. // // * ParameterVersionNotFound -// The specified parameter version was not found. Verify the parameter name -// and version, and try again. +// The specified parameter version wasn't found. Verify the parameter name and +// version, and try again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameter func (c *SSM) GetParameter(input *GetParameterInput) (*GetParameterOutput, error) { @@ -9062,13 +9119,13 @@ func (c *SSM) GetParameterHistoryRequest(input *GetParameterHistoryInput) (req * // An error occurred on the server side. // // * ParameterNotFound -// The parameter could not be found. Verify the name and try again. +// The parameter couldn't be found. Verify the name and try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InvalidKeyId -// The query key ID is not valid. +// The query key ID isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameterHistory func (c *SSM) GetParameterHistory(input *GetParameterHistoryInput) (*GetParameterHistoryOutput, error) { @@ -9188,8 +9245,8 @@ func (c *SSM) GetParametersRequest(input *GetParametersInput) (req *request.Requ // GetParameters API operation for Amazon Simple Systems Manager (SSM). // -// Get details of a parameter. Don't confuse this API action with the GetParameter -// API action. +// Get details of a parameter. Don't confuse this API operation with the GetParameter +// API operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9200,7 +9257,7 @@ func (c *SSM) GetParametersRequest(input *GetParametersInput) (req *request.Requ // // Returned Error Types: // * InvalidKeyId -// The query key ID is not valid. +// The query key ID isn't valid. // // * InternalServerError // An error occurred on the server side. @@ -9299,20 +9356,20 @@ func (c *SSM) GetParametersByPathRequest(input *GetParametersByPathInput) (req * // An error occurred on the server side. // // * InvalidFilterKey -// The specified key is not valid. +// The specified key isn't valid. // // * InvalidFilterOption -// The specified filter option is not valid. Valid options are Equals and BeginsWith. +// The specified filter option isn't valid. Valid options are Equals and BeginsWith. // For Path filter, valid options are Recursive and OneLevel. // // * InvalidFilterValue -// The filter value is not valid. Verify the value and try again. +// The filter value isn't valid. Verify the value and try again. // // * InvalidKeyId -// The query key ID is not valid. +// The query key ID isn't valid. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParametersByPath func (c *SSM) GetParametersByPath(input *GetParametersByPathInput) (*GetParametersByPathOutput, error) { @@ -9444,15 +9501,15 @@ func (c *SSM) GetPatchBaselineRequest(input *GetPatchBaselineInput) (req *reques // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // * InternalServerError // An error occurred on the server side. @@ -9603,19 +9660,21 @@ func (c *SSM) GetServiceSettingRequest(input *GetServiceSettingInput) (req *requ // GetServiceSetting API operation for Amazon Simple Systems Manager (SSM). // -// ServiceSetting is an account-level setting for an AWS service. This setting -// defines how a user interacts with or uses a service or a feature of a service. -// For example, if an AWS service charges money to the account based on feature -// or service usage, then the AWS service team might create a default setting -// of "false". This means the user can't use this feature unless they change -// the setting to "true" and intentionally opt in for a paid feature. -// -// Services map a SettingId object to a setting value. AWS services teams define -// the default value for a SettingId. You can't create a new SettingId, but -// you can overwrite the default value if you have the ssm:UpdateServiceSetting -// permission for the setting. Use the UpdateServiceSetting API action to change -// the default setting. Or use the ResetServiceSetting to change the value back -// to the original value defined by the AWS service team. +// ServiceSetting is an account-level setting for an Amazon Web Services service. +// This setting defines how a user interacts with or uses a service or a feature +// of a service. For example, if an Amazon Web Services service charges money +// to the account based on feature or service usage, then the Amazon Web Services +// service team might create a default setting of false. This means the user +// can't use this feature unless they change the setting to true and intentionally +// opt in for a paid feature. +// +// Services map a SettingId object to a setting value. Amazon Web Services services +// teams define the default value for a SettingId. You can't create a new SettingId, +// but you can overwrite the default value if you have the ssm:UpdateServiceSetting +// permission for the setting. Use the UpdateServiceSetting API operation to +// change the default setting. Or use the ResetServiceSetting to change the +// value back to the original value defined by the Amazon Web Services service +// team. // // Query the current service setting for the account. // @@ -9631,8 +9690,8 @@ func (c *SSM) GetServiceSettingRequest(input *GetServiceSettingInput) (req *requ // An error occurred on the server side. // // * ServiceSettingNotFound -// The specified service setting was not found. Either the service name or the -// setting has not been provisioned by the AWS service team. +// The specified service setting wasn't found. Either the service name or the +// setting hasn't been provisioned by the Amazon Web Services service team. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetServiceSetting func (c *SSM) GetServiceSetting(input *GetServiceSettingInput) (*GetServiceSettingOutput, error) { @@ -9701,9 +9760,10 @@ func (c *SSM) LabelParameterVersionRequest(input *LabelParameterVersionInput) (r // LabelParameterVersion API operation for Amazon Simple Systems Manager (SSM). // // A parameter label is a user-defined alias to help you manage different versions -// of a parameter. When you modify a parameter, Systems Manager automatically -// saves a new version and increments the version number by one. A label can -// help you remember the purpose of a parameter when there are multiple versions. +// of a parameter. When you modify a parameter, Amazon Web Services Systems +// Manager automatically saves a new version and increments the version number +// by one. A label can help you remember the purpose of a parameter when there +// are multiple versions. // // Parameter labels have the following requirements and restrictions. // @@ -9726,8 +9786,8 @@ func (c *SSM) LabelParameterVersionRequest(input *LabelParameterVersionInput) (r // * Labels can contain letters (case sensitive), numbers, periods (.), hyphens // (-), or underscores (_). // -// * Labels can't begin with a number, "aws," or "ssm" (not case sensitive). -// If a label fails to meet these requirements, then the label is not associated +// * Labels can't begin with a number, "aws" or "ssm" (not case sensitive). +// If a label fails to meet these requirements, then the label isn't associated // with a parameter and the system displays it in the list of InvalidLabels. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -9746,11 +9806,11 @@ func (c *SSM) LabelParameterVersionRequest(input *LabelParameterVersionInput) (r // time. // // * ParameterNotFound -// The parameter could not be found. Verify the name and try again. +// The parameter couldn't be found. Verify the name and try again. // // * ParameterVersionNotFound -// The specified parameter version was not found. Verify the parameter name -// and version, and try again. +// The specified parameter version wasn't found. Verify the parameter name and +// version, and try again. // // * ParameterVersionLabelLimitExceeded // A parameter version can have a maximum of ten labels. @@ -9841,10 +9901,10 @@ func (c *SSM) ListAssociationVersionsRequest(input *ListAssociationVersionsInput // An error occurred on the server side. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * AssociationDoesNotExist -// The specified association does not exist. +// The specified association doesn't exist. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListAssociationVersions func (c *SSM) ListAssociationVersions(input *ListAssociationVersionsInput) (*ListAssociationVersionsOutput, error) { @@ -9970,9 +10030,10 @@ func (c *SSM) ListAssociationsRequest(input *ListAssociationsInput) (req *reques // ListAssociations API operation for Amazon Simple Systems Manager (SSM). // -// Returns all State Manager associations in the current AWS account and Region. +// Returns all State Manager associations in the current account and Region. // You can limit the results to a specific State Manager association document -// or instance by specifying a filter. +// or instance by specifying a filter. State Manager is a capability of Amazon +// Web Services Systems Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9986,7 +10047,7 @@ func (c *SSM) ListAssociationsRequest(input *ListAssociationsInput) (req *reques // An error occurred on the server side. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListAssociations func (c *SSM) ListAssociations(input *ListAssociationsInput) (*ListAssociationsOutput, error) { @@ -10130,25 +10191,27 @@ func (c *SSM) ListCommandInvocationsRequest(input *ListCommandInvocationsInput) // An error occurred on the server side. // // * InvalidCommandId -// The specified command ID is not valid. Verify the ID and try again. +// The specified command ID isn't valid. Verify the ID and try again. // // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidFilterKey -// The specified key is not valid. +// The specified key isn't valid. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListCommandInvocations func (c *SSM) ListCommandInvocations(input *ListCommandInvocationsInput) (*ListCommandInvocationsOutput, error) { @@ -10274,7 +10337,7 @@ func (c *SSM) ListCommandsRequest(input *ListCommandsInput) (req *request.Reques // ListCommands API operation for Amazon Simple Systems Manager (SSM). // -// Lists the commands requested by users of the AWS account. +// Lists the commands requested by users of the account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10288,25 +10351,27 @@ func (c *SSM) ListCommandsRequest(input *ListCommandsInput) (req *request.Reques // An error occurred on the server side. // // * InvalidCommandId -// The specified command ID is not valid. Verify the ID and try again. +// The specified command ID isn't valid. Verify the ID and try again. // // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidFilterKey -// The specified key is not valid. +// The specified key isn't valid. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListCommands func (c *SSM) ListCommands(input *ListCommandsInput) (*ListCommandsOutput, error) { @@ -10432,7 +10497,7 @@ func (c *SSM) ListComplianceItemsRequest(input *ListComplianceItemsInput) (req * // ListComplianceItems API operation for Amazon Simple Systems Manager (SSM). // -// For a specified resource ID, this API action returns a list of compliance +// For a specified resource ID, this API operation returns a list of compliance // statuses for different resource types. Currently, you can only specify one // resource ID per call. List results depend on the criteria specified in the // filter. @@ -10446,22 +10511,22 @@ func (c *SSM) ListComplianceItemsRequest(input *ListComplianceItemsInput) (req * // // Returned Error Types: // * InvalidResourceType -// The resource type is not valid. For example, if you are attempting to tag +// The resource type isn't valid. For example, if you are attempting to tag // an instance, the instance must be a registered, managed instance. // // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // * InternalServerError // An error occurred on the server side. // // * InvalidFilter -// The filter name is not valid. Verify the you entered the correct name and +// The filter name isn't valid. Verify the you entered the correct name and // try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListComplianceItems func (c *SSM) ListComplianceItems(input *ListComplianceItemsInput) (*ListComplianceItemsOutput, error) { @@ -10600,11 +10665,11 @@ func (c *SSM) ListComplianceSummariesRequest(input *ListComplianceSummariesInput // // Returned Error Types: // * InvalidFilter -// The filter name is not valid. Verify the you entered the correct name and +// The filter name isn't valid. Verify the you entered the correct name and // try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InternalServerError // An error occurred on the server side. @@ -10741,13 +10806,13 @@ func (c *SSM) ListDocumentMetadataHistoryRequest(input *ListDocumentMetadataHist // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidDocumentVersion -// The document version is not valid or does not exist. +// The document version isn't valid or doesn't exist. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentMetadataHistory func (c *SSM) ListDocumentMetadataHistory(input *ListDocumentMetadataHistoryInput) (*ListDocumentMetadataHistoryOutput, error) { @@ -10835,10 +10900,10 @@ func (c *SSM) ListDocumentVersionsRequest(input *ListDocumentVersionsInput) (req // An error occurred on the server side. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentVersions func (c *SSM) ListDocumentVersions(input *ListDocumentVersionsInput) (*ListDocumentVersionsOutput, error) { @@ -10964,8 +11029,8 @@ func (c *SSM) ListDocumentsRequest(input *ListDocumentsInput) (req *request.Requ // ListDocuments API operation for Amazon Simple Systems Manager (SSM). // -// Returns all Systems Manager (SSM) documents in the current AWS account and -// Region. You can limit the results of this request by using a filter. +// Returns all Systems Manager (SSM) documents in the current account and Region. +// You can limit the results of this request by using a filter. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10979,10 +11044,10 @@ func (c *SSM) ListDocumentsRequest(input *ListDocumentsInput) (req *request.Requ // An error occurred on the server side. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InvalidFilterKey -// The specified key is not valid. +// The specified key isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocuments func (c *SSM) ListDocuments(input *ListDocumentsInput) (*ListDocumentsOutput, error) { @@ -11118,24 +11183,26 @@ func (c *SSM) ListInventoryEntriesRequest(input *ListInventoryEntriesInput) (req // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidTypeNameException -// The parameter type name is not valid. +// The parameter type name isn't valid. // // * InvalidFilter -// The filter name is not valid. Verify the you entered the correct name and +// The filter name isn't valid. Verify the you entered the correct name and // try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListInventoryEntries func (c *SSM) ListInventoryEntries(input *ListInventoryEntriesInput) (*ListInventoryEntriesOutput, error) { @@ -11209,9 +11276,9 @@ func (c *SSM) ListOpsItemEventsRequest(input *ListOpsItemEventsInput) (req *requ // ListOpsItemEvents API operation for Amazon Simple Systems Manager (SSM). // -// Returns a list of all OpsItem events in the current AWS account and Region. -// You can limit the results to events associated with specific OpsItems by -// specifying a filter. +// Returns a list of all OpsItem events in the current Region and account. You +// can limit the results to events associated with specific OpsItems by specifying +// a filter. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11500,8 +11567,8 @@ func (c *SSM) ListOpsMetadataRequest(input *ListOpsMetadataInput) (req *request. // ListOpsMetadata API operation for Amazon Simple Systems Manager (SSM). // -// Systems Manager calls this API action when displaying all Application Manager -// OpsMetadata objects or blobs. +// Amazon Web Services Systems Manager calls this API operation when displaying +// all Application Manager OpsMetadata objects or blobs. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11654,11 +11721,11 @@ func (c *SSM) ListResourceComplianceSummariesRequest(input *ListResourceComplian // // Returned Error Types: // * InvalidFilter -// The filter name is not valid. Verify the you entered the correct name and +// The filter name isn't valid. Verify the you entered the correct name and // try again. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // * InternalServerError // An error occurred on the server side. @@ -11813,7 +11880,7 @@ func (c *SSM) ListResourceDataSyncRequest(input *ListResourceDataSyncInput) (req // An error occurred on the server side. // // * InvalidNextToken -// The specified token is not valid. +// The specified token isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListResourceDataSync func (c *SSM) ListResourceDataSync(input *ListResourceDataSyncInput) (*ListResourceDataSyncOutput, error) { @@ -11935,6 +12002,9 @@ func (c *SSM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * // // Returns a list of the tags assigned to the specified resource. // +// For information about the ID format for each supported resource type, see +// AddTagsToResource. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -11944,12 +12014,12 @@ func (c *SSM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * // // Returned Error Types: // * InvalidResourceType -// The resource type is not valid. For example, if you are attempting to tag +// The resource type isn't valid. For example, if you are attempting to tag // an instance, the instance must be a registered, managed instance. // // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // * InternalServerError // An error occurred on the server side. @@ -12021,10 +12091,10 @@ func (c *SSM) ModifyDocumentPermissionRequest(input *ModifyDocumentPermissionInp // ModifyDocumentPermission API operation for Amazon Simple Systems Manager (SSM). // -// Shares a Systems Manager document publicly or privately. If you share a document -// privately, you must specify the AWS user account IDs for those people who -// can use the document. If you share a document publicly, you must specify -// All as the account ID. +// Shares a Amazon Web Services Systems Manager document (SSM document)publicly +// or privately. If you share a document privately, you must specify the Amazon +// Web Services user account IDs for those people who can use the document. +// If you share a document publicly, you must specify All as the account ID. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12038,19 +12108,20 @@ func (c *SSM) ModifyDocumentPermissionRequest(input *ModifyDocumentPermissionInp // An error occurred on the server side. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidPermissionType -// The permission type is not supported. Share is the only supported permission +// The permission type isn't supported. Share is the only supported permission // type. // // * DocumentPermissionLimit -// The document cannot be shared with more AWS user accounts. You can share -// a document with a maximum of 20 accounts. You can publicly share up to five -// documents. If you need to increase this limit, contact AWS Support. +// The document can't be shared with more Amazon Web Services user accounts. +// You can share a document with a maximum of 20 accounts. You can publicly +// share up to five documents. If you need to increase this limit, contact Amazon +// Web Services Support. // // * DocumentLimitExceeded -// You can have at most 500 active Systems Manager documents. +// You can have at most 500 active SSM documents. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ModifyDocumentPermission func (c *SSM) ModifyDocumentPermission(input *ModifyDocumentPermissionInput) (*ModifyDocumentPermissionOutput, error) { @@ -12120,8 +12191,8 @@ func (c *SSM) PutComplianceItemsRequest(input *PutComplianceItemsInput) (req *re // PutComplianceItems API operation for Amazon Simple Systems Manager (SSM). // // Registers a compliance type and other compliance details on a designated -// resource. This action lets you register custom compliance details with a -// resource. This call overwrites existing compliance information on the resource, +// resource. This operation lets you register custom compliance details with +// a resource. This call overwrites existing compliance information on the resource, // so you must provide a full list of compliance items each time that you send // the request. // @@ -12144,7 +12215,7 @@ func (c *SSM) PutComplianceItemsRequest(input *PutComplianceItemsInput) (req *re // // * Severity: A patch severity. For example, critical. // -// * DocumentName: A SSM document name. For example, AWS-RunPatchBaseline. +// * DocumentName: An SSM document name. For example, AWS-RunPatchBaseline. // // * DocumentVersion: An SSM document version number. For example, 4. // @@ -12174,7 +12245,7 @@ func (c *SSM) PutComplianceItemsRequest(input *PutComplianceItemsInput) (req *re // An error occurred on the server side. // // * InvalidItemContentException -// One or more content items is not valid. +// One or more content items isn't valid. // // * TotalSizeLimitExceededException // The size of inventory data has exceeded the total size limit for the resource. @@ -12187,12 +12258,12 @@ func (c *SSM) PutComplianceItemsRequest(input *PutComplianceItemsInput) (req *re // of 10 different types. // // * InvalidResourceType -// The resource type is not valid. For example, if you are attempting to tag +// The resource type isn't valid. For example, if you are attempting to tag // an instance, the instance must be a registered, managed instance. // // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutComplianceItems func (c *SSM) PutComplianceItems(input *PutComplianceItemsInput) (*PutComplianceItemsOutput, error) { @@ -12278,20 +12349,22 @@ func (c *SSM) PutInventoryRequest(input *PutInventoryInput) (req *request.Reques // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidTypeNameException -// The parameter type name is not valid. +// The parameter type name isn't valid. // // * InvalidItemContentException -// One or more content items is not valid. +// One or more content items isn't valid. // // * TotalSizeLimitExceededException // The size of inventory data has exceeded the total size limit for the resource. @@ -12312,7 +12385,7 @@ func (c *SSM) PutInventoryRequest(input *PutInventoryInput) (req *request.Reques // for each type. // // * UnsupportedInventoryItemContextException -// The Context attribute that you specified for the InventoryItem is not allowed +// The Context attribute that you specified for the InventoryItem isn't allowed // for this inventory type. You can only use the Context attribute with inventory // types like AWS:ComplianceItem. // @@ -12403,11 +12476,11 @@ func (c *SSM) PutParameterRequest(input *PutParameterInput) (req *request.Reques // An error occurred on the server side. // // * InvalidKeyId -// The query key ID is not valid. +// The query key ID isn't valid. // // * ParameterLimitExceeded -// You have exceeded the number of parameters for this AWS account. Delete one -// or more parameters and try again. +// You have exceeded the number of parameters for this account. Delete one or +// more parameters and try again. // // * TooManyUpdates // There are concurrent updates for a resource that supports one update at a @@ -12419,21 +12492,21 @@ func (c *SSM) PutParameterRequest(input *PutParameterInput) (req *request.Reques // * HierarchyLevelLimitExceededException // A hierarchy can have a maximum of 15 levels. For more information, see Requirements // and constraints for parameter names (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html) -// in the AWS Systems Manager User Guide. +// in the Amazon Web Services Systems Manager User Guide. // // * HierarchyTypeMismatchException -// Parameter Store does not support changing a parameter type in a hierarchy. +// Parameter Store doesn't support changing a parameter type in a hierarchy. // For example, you can't change a parameter from a String type to a SecureString // type. You must create a new, unique parameter. // // * InvalidAllowedPatternException -// The request does not meet the regular expression requirement. +// The request doesn't meet the regular expression requirement. // // * ParameterMaxVersionLimitExceeded // Parameter Store retains the 100 most recently created versions of a parameter. // After this number of versions has been created, Parameter Store deletes the // oldest version when a new one is created. However, if the oldest version -// has a label attached to it, Parameter Store will not delete the version and +// has a label attached to it, Parameter Store won't delete the version and // instead presents this error message: // // An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter @@ -12448,21 +12521,21 @@ func (c *SSM) PutParameterRequest(input *PutParameterInput) (req *request.Reques // one for use in your operations. For information about moving parameter labels, // see Move a parameter label (console) (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-console-move) // or Move a parameter label (CLI) (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-cli-move) -// in the AWS Systems Manager User Guide. +// in the Amazon Web Services Systems Manager User Guide. // // * ParameterPatternMismatchException -// The parameter name is not valid. +// The parameter name isn't valid. // // * UnsupportedParameterType -// The parameter type is not supported. +// The parameter type isn't supported. // // * PoliciesLimitExceededException // You specified more than the maximum number of allowed policies for the parameter. // The maximum is 10. // // * InvalidPolicyTypeException -// The policy type is not supported. Parameter Store supports the following -// policy types: Expiration, ExpirationNotification, and NoChangeNotification. +// The policy type isn't supported. Parameter Store supports the following policy +// types: Expiration, ExpirationNotification, and NoChangeNotification. // // * InvalidPolicyAttributeException // A policy attribute or its value is invalid. @@ -12540,10 +12613,10 @@ func (c *SSM) RegisterDefaultPatchBaselineRequest(input *RegisterDefaultPatchBas // // Defines the default patch baseline for the relevant operating system. // -// To reset the AWS predefined patch baseline as the default, specify the full -// patch baseline ARN as the baseline ID value. For example, for CentOS, specify -// arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead -// of pb-0574b43a65ea646ed. +// To reset the Amazon Web Services-predefined patch baseline as the default, +// specify the full patch baseline Amazon Resource Name (ARN) as the baseline +// ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed +// instead of pb-0574b43a65ea646ed. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12554,16 +12627,16 @@ func (c *SSM) RegisterDefaultPatchBaselineRequest(input *RegisterDefaultPatchBas // // Returned Error Types: // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -12650,23 +12723,23 @@ func (c *SSM) RegisterPatchBaselineForPatchGroupRequest(input *RegisterPatchBase // // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // * ResourceLimitExceededException // Error returned when the caller has exceeded the default resource quotas. // For example, too many maintenance windows or patch baselines have been created. // // For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -12753,19 +12826,19 @@ func (c *SSM) RegisterTargetWithMaintenanceWindowRequest(input *RegisterTargetWi // // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * ResourceLimitExceededException // Error returned when the caller has exceeded the default resource quotas. // For example, too many maintenance windows or patch baselines have been created. // // For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -12852,23 +12925,23 @@ func (c *SSM) RegisterTaskWithMaintenanceWindowRequest(input *RegisterTaskWithMa // // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * ResourceLimitExceededException // Error returned when the caller has exceeded the default resource quotas. // For example, too many maintenance windows or patch baselines have been created. // // For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * FeatureNotAvailableException // You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where -// the corresponding service is not available. +// the corresponding service isn't available. // // * InternalServerError // An error occurred on the server side. @@ -12951,12 +13024,12 @@ func (c *SSM) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) // // Returned Error Types: // * InvalidResourceType -// The resource type is not valid. For example, if you are attempting to tag +// The resource type isn't valid. For example, if you are attempting to tag // an instance, the instance must be a registered, managed instance. // // * InvalidResourceId -// The resource ID is not valid. Verify that you entered the correct ID and -// try again. +// The resource ID isn't valid. Verify that you entered the correct ID and try +// again. // // * InternalServerError // An error occurred on the server side. @@ -13031,22 +13104,23 @@ func (c *SSM) ResetServiceSettingRequest(input *ResetServiceSettingInput) (req * // ResetServiceSetting API operation for Amazon Simple Systems Manager (SSM). // -// ServiceSetting is an account-level setting for an AWS service. This setting -// defines how a user interacts with or uses a service or a feature of a service. -// For example, if an AWS service charges money to the account based on feature -// or service usage, then the AWS service team might create a default setting -// of "false". This means the user can't use this feature unless they change -// the setting to "true" and intentionally opt in for a paid feature. -// -// Services map a SettingId object to a setting value. AWS services teams define -// the default value for a SettingId. You can't create a new SettingId, but -// you can overwrite the default value if you have the ssm:UpdateServiceSetting -// permission for the setting. Use the GetServiceSetting API action to view -// the current value. Use the UpdateServiceSetting API action to change the +// ServiceSetting is an account-level setting for an Amazon Web Services service. +// This setting defines how a user interacts with or uses a service or a feature +// of a service. For example, if an Amazon Web Services service charges money +// to the account based on feature or service usage, then the Amazon Web Services +// service team might create a default setting of "false". This means the user +// can't use this feature unless they change the setting to "true" and intentionally +// opt in for a paid feature. +// +// Services map a SettingId object to a setting value. Amazon Web Services services +// teams define the default value for a SettingId. You can't create a new SettingId, +// but you can overwrite the default value if you have the ssm:UpdateServiceSetting +// permission for the setting. Use the GetServiceSetting API operation to view +// the current value. Use the UpdateServiceSetting API operation to change the // default setting. // // Reset the service setting for the account to the default value as provisioned -// by the AWS service team. +// by the Amazon Web Services service team. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13060,8 +13134,8 @@ func (c *SSM) ResetServiceSettingRequest(input *ResetServiceSettingInput) (req * // An error occurred on the server side. // // * ServiceSettingNotFound -// The specified service setting was not found. Either the service name or the -// setting has not been provisioned by the AWS service team. +// The specified service setting wasn't found. Either the service name or the +// setting hasn't been provisioned by the Amazon Web Services service team. // // * TooManyUpdates // There are concurrent updates for a resource that supports one update at a @@ -13137,7 +13211,7 @@ func (c *SSM) ResumeSessionRequest(input *ResumeSessionInput) (req *request.Requ // can be resumed for disconnected sessions, but not terminated sessions. // // This command is primarily for use by client machines to automatically reconnect -// during intermittent network issues. It is not intended for any other use. +// during intermittent network issues. It isn't intended for any other use. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13149,11 +13223,11 @@ func (c *SSM) ResumeSessionRequest(input *ResumeSessionInput) (req *request.Requ // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -13245,7 +13319,7 @@ func (c *SSM) SendAutomationSignalRequest(input *SendAutomationSignalInput) (req // and try again. // // * InvalidAutomationSignalException -// The signal is not valid for the current Automation execution. +// The signal isn't valid for the current Automation execution. // // * InternalServerError // An error occurred on the server side. @@ -13327,7 +13401,7 @@ func (c *SSM) SendCommandRequest(input *SendCommandInput) (req *request.Request, // // Returned Error Types: // * DuplicateInstanceId -// You cannot specify an instance ID in more than one association. +// You can't specify an instance ID in more than one association. // // * InternalServerError // An error occurred on the server side. @@ -13335,31 +13409,33 @@ func (c *SSM) SendCommandRequest(input *SendCommandInput) (req *request.Request, // * InvalidInstanceId // The following problems can cause this exception: // -// You do not have permission to access the instance. +// * You don't have permission to access the instance. // -// SSM Agent is not running. Verify that SSM Agent is running. +// * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. +// Verify that SSM Agent is running. // -// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent. +// * SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. // -// The instance is not in valid state. Valid states are: Running, Pending, Stopped, -// Stopping. Invalid states are: Shutting-down and Terminated. +// * The instance isn't in valid state. Valid states are: Running, Pending, +// Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. // // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * InvalidDocumentVersion -// The document version is not valid or does not exist. +// The document version isn't valid or doesn't exist. // // * InvalidOutputFolder -// The S3 bucket does not exist. +// The S3 bucket doesn't exist. // // * InvalidParameters -// You must specify values for all required parameters in the Systems Manager -// document. You can only supply values to parameters defined in the Systems -// Manager document. +// You must specify values for all required parameters in the Amazon Web Services +// Systems Manager document (SSM document). You can only supply values to parameters +// defined in the SSM document. // // * UnsupportedPlatformType -// The document does not support the platform type of the given instance ID(s). +// The document doesn't support the platform type of the given instance ID(s). // For example, you sent an document for a Windows instance to a Linux instance. // // * MaxDocumentSizeExceeded @@ -13370,11 +13446,11 @@ func (c *SSM) SendCommandRequest(input *SendCommandInput) (req *request.Request, // an IAM role for notifications that includes the required trust policy. For // information about configuring the IAM role for Run Command notifications, // see Configuring Amazon SNS Notifications for Run Command (https://docs.aws.amazon.com/systems-manager/latest/userguide/rc-sns-notifications.html) -// in the AWS Systems Manager User Guide. +// in the Amazon Web Services Systems Manager User Guide. // // * InvalidNotificationConfig -// One or more configuration items is not valid. Verify that a valid Amazon -// Resource Name (ARN) was provided for an Amazon SNS topic. +// One or more configuration items isn't valid. Verify that a valid Amazon Resource +// Name (ARN) was provided for an Amazon Simple Notification Service topic. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/SendCommand func (c *SSM) SendCommand(input *SendCommandInput) (*SendCommandOutput, error) { @@ -13443,8 +13519,8 @@ func (c *SSM) StartAssociationsOnceRequest(input *StartAssociationsOnceInput) (r // StartAssociationsOnce API operation for Amazon Simple Systems Manager (SSM). // -// Use this API action to run an association immediately and only one time. -// This action can be helpful when troubleshooting associations. +// Runs an association immediately and only one time. This operation can be +// helpful when troubleshooting associations. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13455,10 +13531,10 @@ func (c *SSM) StartAssociationsOnceRequest(input *StartAssociationsOnceInput) (r // // Returned Error Types: // * InvalidAssociation -// The association is not valid or does not exist. +// The association isn't valid or doesn't exist. // // * AssociationDoesNotExist -// The specified association does not exist. +// The specified association doesn't exist. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartAssociationsOnce func (c *SSM) StartAssociationsOnce(input *StartAssociationsOnceInput) (*StartAssociationsOnceOutput, error) { @@ -13526,7 +13602,7 @@ func (c *SSM) StartAutomationExecutionRequest(input *StartAutomationExecutionInp // StartAutomationExecution API operation for Amazon Simple Systems Manager (SSM). // -// Initiates execution of an Automation document. +// Initiates execution of an Automation runbook. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13537,10 +13613,10 @@ func (c *SSM) StartAutomationExecutionRequest(input *StartAutomationExecutionInp // // Returned Error Types: // * AutomationDefinitionNotFoundException -// An Automation document with the specified name could not be found. +// An Automation runbook with the specified name couldn't be found. // // * InvalidAutomationExecutionParametersException -// The supplied parameters for invoking the specified Automation document are +// The supplied parameters for invoking the specified Automation runbook are // incorrect. For example, they may not match the set of parameters permitted // for the specified Automation document. // @@ -13549,15 +13625,15 @@ func (c *SSM) StartAutomationExecutionRequest(input *StartAutomationExecutionInp // limit. // // * AutomationDefinitionVersionNotFoundException -// An Automation document with the specified name and version could not be found. +// An Automation runbook with the specified name and version couldn't be found. // // * IdempotentParameterMismatch // Error returned when an idempotent operation is retried and the parameters // don't match the original call to the API with the same idempotency token. // // * InvalidTarget -// The target is not valid or does not exist. It might not be configured for -// Systems Manager or you might not have permission to perform the operation. +// The target isn't valid or doesn't exist. It might not be configured for Systems +// Manager or you might not have permission to perform the operation. // // * InternalServerError // An error occurred on the server side. @@ -13628,9 +13704,9 @@ func (c *SSM) StartChangeRequestExecutionRequest(input *StartChangeRequestExecut // StartChangeRequestExecution API operation for Amazon Simple Systems Manager (SSM). // -// Creates a change request for Change Manager. The runbooks (Automation documents) -// specified in the change request run only after all required approvals for -// the change request have been received. +// Creates a change request for Change Manager. The Automation runbooks specified +// in the change request run only after all required approvals for the change +// request have been received. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13641,10 +13717,10 @@ func (c *SSM) StartChangeRequestExecutionRequest(input *StartChangeRequestExecut // // Returned Error Types: // * AutomationDefinitionNotFoundException -// An Automation document with the specified name could not be found. +// An Automation runbook with the specified name couldn't be found. // // * InvalidAutomationExecutionParametersException -// The supplied parameters for invoking the specified Automation document are +// The supplied parameters for invoking the specified Automation runbook are // incorrect. For example, they may not match the set of parameters permitted // for the specified Automation document. // @@ -13653,7 +13729,7 @@ func (c *SSM) StartChangeRequestExecutionRequest(input *StartChangeRequestExecut // limit. // // * AutomationDefinitionVersionNotFoundException -// An Automation document with the specified name and version could not be found. +// An Automation runbook with the specified name and version couldn't be found. // // * IdempotentParameterMismatch // Error returned when an idempotent operation is retried and the parameters @@ -13736,13 +13812,14 @@ func (c *SSM) StartSessionRequest(input *StartSessionInput) (req *request.Reques // Manager session. Returns a URL and token that can be used to open a WebSocket // connection for sending input and receiving outputs. // -// AWS CLI usage: start-session is an interactive command that requires the -// Session Manager plugin to be installed on the client machine making the call. -// For information, see Install the Session Manager plugin for the AWS CLI (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) -// in the AWS Systems Manager User Guide. +// Amazon Web Services CLI usage: start-session is an interactive command that +// requires the Session Manager plugin to be installed on the client machine +// making the call. For information, see Install the Session Manager plugin +// for the Amazon Web Services CLI (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) +// in the Amazon Web Services Systems Manager User Guide. // -// AWS Tools for PowerShell usage: Start-SSMSession is not currently supported -// by AWS Tools for PowerShell on Windows local machines. +// Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently +// supported by Amazon Web Services Tools for PowerShell on Windows local machines. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13753,15 +13830,15 @@ func (c *SSM) StartSessionRequest(input *StartSessionInput) (req *request.Reques // // Returned Error Types: // * InvalidDocument -// The specified document does not exist. +// The specified SSM document doesn't exist. // // * TargetNotConnected -// The specified target instance for the session is not fully configured for +// The specified target instance for the session isn't fully configured for // use with Session Manager. For more information, see Getting started with // Session Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html) -// in the AWS Systems Manager User Guide. This error is also returned if you -// attempt to start a session on an instance that is located in a different -// account or Region +// in the Amazon Web Services Systems Manager User Guide. This error is also +// returned if you attempt to start a session on an instance that is located +// in a different account or Region // // * InternalServerError // An error occurred on the server side. @@ -13848,7 +13925,7 @@ func (c *SSM) StopAutomationExecutionRequest(input *StopAutomationExecutionInput // execution ID. // // * InvalidAutomationStatusUpdateException -// The specified update status operation is not valid. +// The specified update status operation isn't valid. // // * InternalServerError // An error occurred on the server side. @@ -13920,7 +13997,7 @@ func (c *SSM) TerminateSessionRequest(input *TerminateSessionInput) (req *reques // TerminateSession API operation for Amazon Simple Systems Manager (SSM). // // Permanently ends a session and closes the data connection between the Session -// Manager client and SSM Agent on the instance. A terminated session cannot +// Manager client and SSM Agent on the instance. A terminated session isn't // be resumed. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -13933,11 +14010,11 @@ func (c *SSM) TerminateSessionRequest(input *TerminateSessionInput) (req *reques // Returned Error Types: // * DoesNotExistException // Error returned when the ID specified for a resource, such as a maintenance -// window or Patch baseline, doesn't exist. +// window or patch baseline, doesn't exist. // -// For information about resource quotas in Systems Manager, see Systems Manager -// service quotas (http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) -// in the AWS General Reference. +// For information about resource quotas in Amazon Web Services Systems Manager, +// see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. // // * InternalServerError // An error occurred on the server side. @@ -14026,11 +14103,11 @@ func (c *SSM) UnlabelParameterVersionRequest(input *UnlabelParameterVersionInput // time. // // * ParameterNotFound -// The parameter could not be found. Verify the name and try again. +// The parameter couldn't be found. Verify the name and try again. // // * ParameterVersionNotFound -// The specified parameter version was not found. Verify the parameter name -// and version, and try again. +// The specified parameter version wasn't found. Verify the parameter name and +// version, and try again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UnlabelParameterVersion func (c *SSM) UnlabelParameterVersion(input *UnlabelParameterVersionInput) (*UnlabelParameterVersionOutput, error) { @@ -14099,14 +14176,16 @@ func (c *SSM) UpdateAssociationRequest(input *UpdateAssociationInput) (req *requ // UpdateAssociation API operation for Amazon Simple Systems Manager (SSM). // // Updates an association. You can update the association name and version, -// the document version, schedule, parameters, and Amazon S3 output. +// the document version, schedule, parameters, and Amazon Simple Storage Service +// (Amazon S3) output. // -// In order to call this API action, your IAM user account, group, or role must -// be configured with permission to call the DescribeAssociation API action. -// If you don't have permission to call DescribeAssociation, then you receive -// the following error: An error occurred (AccessDeniedException) when calling -// the UpdateAssociation operation: User: