SSM / Paginator / ListOpsItemRelatedItems

ListOpsItemRelatedItems

class SSM.Paginator.ListOpsItemRelatedItems

paginator = client.get_paginator('list_ops_item_related_items')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.list_ops_item_related_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OpsItemId='string',
    Filters=[
        {
            'Key': 'ResourceType'|'AssociationId'|'ResourceUri',
            'Values': [
                'string',
            ],
            'Operator': 'Equal'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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, or AssociationId.

    • 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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) –

  • 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.