RAM / Paginator / ListSourceAssociations

ListSourceAssociations

class RAM.Paginator.ListSourceAssociations
paginator = client.get_paginator('list_source_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RAM.Client.list_source_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceShareArns=[
        'string',
    ],
    sourceId='string',
    sourceType='string',
    associationStatus='ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED'|'SUSPENDED'|'SUSPENDING'|'RESTORING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • resourceShareArns (list) –

    The Amazon Resource Names (ARNs) of the resource shares for which you want to retrieve source associations.

    • (string) –

  • sourceId (string) – The identifier of the source for which you want to retrieve associations. This can be an account ID, Amazon Resource Name (ARN), organization ID, or organization path.

  • sourceType (string) – The type of source for which you want to retrieve associations.

  • associationStatus (string) – The status of the source associations that you want to retrieve.

  • 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

{
    'sourceAssociations': [
        {
            'resourceShareArn': 'string',
            'sourceId': 'string',
            'sourceType': 'string',
            'status': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'creationTime': datetime(2015, 1, 1),
            'statusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • sourceAssociations (list) –

      Information about the source associations.

      • (dict) –

        Information about a source association in a resource share. Source associations control which sources can be used with service principals.

        • resourceShareArn (string) –

          The Amazon Resource Name (ARN) of the resource share that contains the source association.

        • sourceId (string) –

          The identifier of the source. This can be an account ID, Amazon Resource Name (ARN), organization ID, or organization path.

        • sourceType (string) –

          The type of source.

        • status (string) –

          The current status of the source association.

        • lastUpdatedTime (datetime) –

          The date and time when the source association was last updated.

        • creationTime (datetime) –

          The date and time when the source association was created.

        • statusMessage (string) –

          A message about the status of the source association.

    • NextToken (string) –

      A token to resume pagination.