2018/07/02 - Amazon Simple Systems Manager (SSM) - 3 new api methods
Changes Update ssm client to latest version
Use this API action to execute an association immediately and only one time. This action can be helpful when troubleshooting associations.
See also: AWS API Documentation
Request Syntax
client.start_associations_once(
AssociationIds=[
'string',
]
)
list
[REQUIRED]
The association IDs that you want to execute immediately and only one time.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Use this API action to view all executions for a specific association ID.
See also: AWS API Documentation
Request Syntax
client.describe_association_executions(
AssociationId='string',
Filters=[
{
'Key': 'ExecutionId'|'Status'|'CreatedTime',
'Value': 'string',
'Type': 'EQUAL'|'LESS_THAN'|'GREATER_THAN'
},
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The association ID for which you want to view execution history details.
list
Filters for the request. You can specify the following filters and values.
ExecutionId (EQUAL)
Status (EQUAL)
CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)
(dict) --
Filters used in the request.
Key (string) -- [REQUIRED]
The key value used in the request.
Value (string) -- [REQUIRED]
The value specified for the key.
Type (string) -- [REQUIRED]
The filter type specified in the request.
integer
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
string
A token to start the list. Use this token to get the next set of results.
dict
Response Syntax
{
'AssociationExecutions': [
{
'AssociationId': 'string',
'AssociationVersion': 'string',
'ExecutionId': 'string',
'Status': 'string',
'DetailedStatus': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastExecutionDate': datetime(2015, 1, 1),
'ResourceCountByStatus': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AssociationExecutions (list) --
A list of the executions for the specified association ID.
(dict) --
Includes information about the specified association.
AssociationId (string) --
The association ID.
AssociationVersion (string) --
The association version.
ExecutionId (string) --
The execution ID for the association. If the association does not run at intervals or according to a schedule, then the ExecutionID is the same as the AssociationID.
Status (string) --
The status of the association execution.
DetailedStatus (string) --
Detailed status information about the execution.
CreatedTime (datetime) --
The time the execution started.
LastExecutionDate (datetime) --
The date of the last execution.
ResourceCountByStatus (string) --
An aggregate status of the resources in the execution based on the status type.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Use this API action to view information about a specific execution of a specific association.
See also: AWS API Documentation
Request Syntax
client.describe_association_execution_targets(
AssociationId='string',
ExecutionId='string',
Filters=[
{
'Key': 'Status'|'ResourceId'|'ResourceType',
'Value': 'string'
},
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The association ID that includes the execution for which you want to view details.
string
[REQUIRED]
The execution ID for which you want to view details.
list
Filters for the request. You can specify the following filters and values.
Status (EQUAL)
ResourceId (EQUAL)
ResourceType (EQUAL)
(dict) --
Filters for the association execution.
Key (string) -- [REQUIRED]
The key value used in the request.
Value (string) -- [REQUIRED]
The value specified for the key.
integer
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
string
A token to start the list. Use this token to get the next set of results.
dict
Response Syntax
{
'AssociationExecutionTargets': [
{
'AssociationId': 'string',
'AssociationVersion': 'string',
'ExecutionId': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'Status': 'string',
'DetailedStatus': 'string',
'LastExecutionDate': datetime(2015, 1, 1),
'OutputSource': {
'OutputSourceId': 'string',
'OutputSourceType': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AssociationExecutionTargets (list) --
Information about the execution.
(dict) --
Includes information about the specified association execution.
AssociationId (string) --
The association ID.
AssociationVersion (string) --
The association version.
ExecutionId (string) --
The execution ID. If the association does not run at intervals or according to a schedule, then the ExecutionID is the same as the AssociationID.
ResourceId (string) --
The resource ID, for example, the instance ID where the association ran.
ResourceType (string) --
The resource type, for example, instance.
Status (string) --
The association execution status.
DetailedStatus (string) --
Detailed information about the execution status.
LastExecutionDate (datetime) --
The date of the last execution.
OutputSource (dict) --
The location where the association details are saved.
OutputSourceId (string) --
The ID of the output source, for example the URL of an Amazon S3 bucket.
OutputSourceType (string) --
The type of source where the association execution details are stored, for example, Amazon S3.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.