RAM / Paginator / GetResourceShareAssociations

GetResourceShareAssociations

class RAM.Paginator.GetResourceShareAssociations

paginator = client.get_paginator('get_resource_share_associations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    associationType='PRINCIPAL'|'RESOURCE',
    resourceShareArns=[
        'string',
    ],
    resourceArn='string',
    principal='string',
    associationStatus='ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• associationType (string) –

  [REQUIRED]

  Specifies whether you want to retrieve the associations that involve a specified resource or principal.

  • PRINCIPAL – list the principals that are associated with the specified resource share.

  • RESOURCE – list the resources that are associated with the specified resource share.

• resourceShareArns (list) –

  Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.

  • (string) –

• resourceArn (string) –

  Specifies the Amazon Resoure Name (ARN) of the resource whose resource shares you want to retrieve.

  You cannot specify this parameter if the association type is PRINCIPAL.

• principal (string) –

  Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resoure Name (ARN) of an individual IAM user or role.

  You cannot specify this parameter if the association type is RESOURCE.

• associationStatus (string) – Specifies that you want to retrieve only associations with this status.

• 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

{
    'resourceShareAssociations': [
        {
            'resourceShareArn': 'string',
            'resourceShareName': 'string',
            'associatedEntity': 'string',
            'associationType': 'PRINCIPAL'|'RESOURCE',
            'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
            'statusMessage': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'external': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • resourceShareAssociations (list) –

    An array of objects that contain the details about the associations.

    • (dict) –

      Describes an association with a resource share and either a principal or a resource.

      • resourceShareArn (string) –

        The Amazon Resoure Name (ARN) of the resource share.

      • resourceShareName (string) –

        The name of the resource share.

      • associatedEntity (string) –

        The associated entity. This can be either of the following:

        • For a resource association, this is the Amazon Resoure Name (ARN) of the resource.

        • For principal associations, this is one of the following:

          • The ID of an Amazon Web Services account

          • The Amazon Resoure Name (ARN) of an organization in Organizations

          • The ARN of an organizational unit (OU) in Organizations

          • The ARN of an IAM role

          • The ARN of an IAM user

      • associationType (string) –

        The type of entity included in this association.

      • status (string) –

        The current status of the association.

      • statusMessage (string) –

        A message about the status of the association.

      • creationTime (datetime) –

        The date and time when the association was created.

      • lastUpdatedTime (datetime) –

        The date and time when the association was last updated.

      • external (boolean) –

        Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.

  • NextToken (string) –

    A token to resume pagination.