SSM / Client / list_ops_item_related_items
list_ops_item_related_items#
- SSM.Client.list_ops_item_related_items(**kwargs)#
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
See also: AWS API Documentation
Request Syntax
response = client.list_ops_item_related_items( OpsItemId='string', Filters=[ { 'Key': 'ResourceType'|'AssociationId'|'ResourceUri', 'Values': [ 'string', ], 'Operator': 'Equal' }, ], MaxResults=123, NextToken='string' )
- Parameters:
OpsItemId (string) – The ID of the OpsItem for which you want to list all related-item resources.
Filters (list) –
One or more OpsItem filters. Use a filter to return a more specific list of results.
(dict) –
Describes a filter for a specific list of related-item resources.
Key (string) – [REQUIRED]
The name of the filter key. Supported values include
ResourceUri
,ResourceType
, orAssociationId
.Values (list) – [REQUIRED]
The values for the filter.
(string) –
Operator (string) – [REQUIRED]
The operator used by the filter call. The only supported operator is
EQUAL
.
MaxResults (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.
NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)
- Return type:
dict
- Returns:
Response Syntax
{ 'NextToken': 'string', 'Summaries': [ { 'OpsItemId': 'string', 'AssociationId': 'string', 'ResourceType': 'string', 'AssociationType': 'string', 'ResourceUri': 'string', 'CreatedBy': { 'Arn': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'Arn': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1) }, ] }
Response Structure
(dict) –
NextToken (string) –
The token for the next set of items to return. Use this token to get the next set of results.
Summaries (list) –
A list of related-item resources for the specified OpsItem.
(dict) –
Summary information about related-item resources for an OpsItem.
OpsItemId (string) –
The OpsItem ID.
AssociationId (string) –
The association ID.
ResourceType (string) –
The resource type.
AssociationType (string) –
The association type.
ResourceUri (string) –
The Amazon Resource Name (ARN) of the related-item resource.
CreatedBy (dict) –
Information about the user or resource that created an OpsItem event.
Arn (string) –
The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.
CreatedTime (datetime) –
The time the related-item association was created.
LastModifiedBy (dict) –
Information about the user or resource that created an OpsItem event.
Arn (string) –
The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.
LastModifiedTime (datetime) –
The time the related-item association was last updated.
Exceptions
SSM.Client.exceptions.InternalServerError
SSM.Client.exceptions.OpsItemInvalidParameterException