StartAssociationsOnce - AWS Systems Manager
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

StartAssociationsOnce

Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.

Request Syntax

{ "AssociationIds": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AssociationIds

The association IDs that you want to run immediately and only one time.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AssociationDoesNotExist

The specified association does not exist.

HTTP Status Code: 400

InvalidAssociation

The association is not valid or does not exist.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.StartAssociationsOnce Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20200325T163434Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200325/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 60 { "AssociationIds":[ "4332cf28-050d-4fa1-a4df-11b39EXAMPLE" ] }

Sample Response

{}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: