RAM

Client

class RAM.Client

A low-level client representing AWS Resource Access Manager (RAM):

client = session.create_client('ram')

These are the available methods:

accept_resource_share_invitation(**kwargs)

Accepts an invitation to a resource share from another AWS account.

See also: AWS API Documentation

Request Syntax

response = client.accept_resource_share_invitation(
    resourceShareInvitationArn='string',
    clientToken='string'
)
Parameters
  • resourceShareInvitationArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the invitation.

  • clientToken (string) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Return type

dict

Returns

Response Syntax

{
    'resourceShareInvitation': {
        'resourceShareInvitationArn': 'string',
        'resourceShareName': 'string',
        'resourceShareArn': 'string',
        'senderAccountId': 'string',
        'receiverAccountId': 'string',
        'invitationTimestamp': datetime(2015, 1, 1),
        'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'EXPIRED',
        '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
            },
        ]
    },
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • resourceShareInvitation (dict) --

      Information about the invitation.

      • resourceShareInvitationArn (string) --

        The Amazon Resource Name (ARN) of the invitation.

      • resourceShareName (string) --

        The name of the resource share.

      • resourceShareArn (string) --

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

      • senderAccountId (string) --

        The ID of the AWS account that sent the invitation.

      • receiverAccountId (string) --

        The ID of the AWS account that received the invitation.

      • invitationTimestamp (datetime) --

        The date and time when the invitation was sent.

      • status (string) --

        The status of the invitation.

      • resourceShareAssociations (list) --

        To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources .

        • (dict) --

          Describes an association with a resource share.

          • resourceShareArn (string) --

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

          • resourceShareName (string) --

            The name of the resource share.

          • associatedEntity (string) --

            The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

          • associationType (string) --

            The association type.

          • status (string) --

            The status of the association.

          • statusMessage (string) --

            A message about the status of the association.

          • creationTime (datetime) --

            The time when the association was created.

          • lastUpdatedTime (datetime) --

            The time when the association was last updated.

          • external (boolean) --

            Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • clientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Exceptions

associate_resource_share(**kwargs)

Associates the specified resource share with the specified principals and resources.

See also: AWS API Documentation

Request Syntax

response = client.associate_resource_share(
    resourceShareArn='string',
    resourceArns=[
        'string',
    ],
    principals=[
        'string',
    ],
    clientToken='string'
)
Parameters
  • resourceShareArn (string) --

    [REQUIRED]

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

  • resourceArns (list) --

    The Amazon Resource Names (ARN) of the resources.

    • (string) --
  • principals (list) --

    The principals.

    • (string) --
  • clientToken (string) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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
        },
    ],
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • resourceShareAssociations (list) --

      Information about the associations.

      • (dict) --

        Describes an association with a resource share.

        • resourceShareArn (string) --

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

        • resourceShareName (string) --

          The name of the resource share.

        • associatedEntity (string) --

          The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

        • associationType (string) --

          The association type.

        • status (string) --

          The status of the association.

        • statusMessage (string) --

          A message about the status of the association.

        • creationTime (datetime) --

          The time when the association was created.

        • lastUpdatedTime (datetime) --

          The time when the association was last updated.

        • external (boolean) --

          Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • clientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Exceptions

associate_resource_share_permission(**kwargs)

Associates a permission with a resource share.

See also: AWS API Documentation

Request Syntax

response = client.associate_resource_share_permission(
    resourceShareArn='string',
    permissionArn='string',
    replace=True|False,
    clientToken='string'
)
Parameters
  • resourceShareArn (string) --

    [REQUIRED]

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

  • permissionArn (string) --

    [REQUIRED]

    The ARN of the AWS RAM permission to associate with the resource share.

  • replace (boolean) -- Indicates whether the permission should replace the permissions that are currently associated with the resource share. Use true to replace the current permissions. Use false to add the permission to the current permission.
  • clientToken (string) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Return type

dict

Returns

Response Syntax

{
    'returnValue': True|False,
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • returnValue (boolean) --

      Indicates whether the request succeeded.

    • clientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_resource_share(**kwargs)

Creates a resource share.

See also: AWS API Documentation

Request Syntax

response = client.create_resource_share(
    name='string',
    resourceArns=[
        'string',
    ],
    principals=[
        'string',
    ],
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    allowExternalPrincipals=True|False,
    clientToken='string',
    permissionArns=[
        'string',
    ]
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the resource share.

  • resourceArns (list) --

    The Amazon Resource Names (ARN) of the resources to associate with the resource share.

    • (string) --
  • principals (list) --

    The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.

    • (string) --
  • tags (list) --

    One or more tags.

    • (dict) --

      Information about a tag.

      • key (string) --

        The key of the tag.

      • value (string) --

        The value of the tag.

  • allowExternalPrincipals (boolean) -- Indicates whether principals outside your AWS organization can be associated with a resource share.
  • clientToken (string) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  • permissionArns (list) --

    The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'resourceShare': {
        'resourceShareArn': 'string',
        'name': 'string',
        'owningAccountId': 'string',
        'allowExternalPrincipals': True|False,
        'status': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
        'statusMessage': 'string',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'creationTime': datetime(2015, 1, 1),
        'lastUpdatedTime': datetime(2015, 1, 1),
        'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD'
    },
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • resourceShare (dict) --

      Information about the resource share.

      • resourceShareArn (string) --

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

      • name (string) --

        The name of the resource share.

      • owningAccountId (string) --

        The ID of the AWS account that owns the resource share.

      • allowExternalPrincipals (boolean) --

        Indicates whether principals outside your AWS organization can be associated with a resource share.

      • status (string) --

        The status of the resource share.

      • statusMessage (string) --

        A message about the status of the resource share.

      • tags (list) --

        The tags for the resource share.

        • (dict) --

          Information about a tag.

          • key (string) --

            The key of the tag.

          • value (string) --

            The value of the tag.

      • creationTime (datetime) --

        The time when the resource share was created.

      • lastUpdatedTime (datetime) --

        The time when the resource share was last updated.

      • featureSet (string) --

        Indicates how the resource share was created. Possible values include:

        • CREATED_FROM_POLICY - Indicates that the resource share was created from an AWS Identity and Access Management (AWS IAM) policy attached to a resource. These resource shares are visible only to the AWS account that created it. They cannot be modified in AWS RAM.
        • PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy .
        • STANDARD - Indicates that the resource share was created in AWS RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in AWS RAM.
    • clientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Exceptions

delete_resource_share(**kwargs)

Deletes the specified resource share.

See also: AWS API Documentation

Request Syntax

response = client.delete_resource_share(
    resourceShareArn='string',
    clientToken='string'
)
Parameters
  • resourceShareArn (string) --

    [REQUIRED]

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

  • clientToken (string) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Return type

dict

Returns

Response Syntax

{
    'returnValue': True|False,
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • returnValue (boolean) --

      Indicates whether the request succeeded.

    • clientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Exceptions

disassociate_resource_share(**kwargs)

Disassociates the specified principals or resources from the specified resource share.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_resource_share(
    resourceShareArn='string',
    resourceArns=[
        'string',
    ],
    principals=[
        'string',
    ],
    clientToken='string'
)
Parameters
  • resourceShareArn (string) --

    [REQUIRED]

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

  • resourceArns (list) --

    The Amazon Resource Names (ARNs) of the resources.

    • (string) --
  • principals (list) --

    The principals.

    • (string) --
  • clientToken (string) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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
        },
    ],
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • resourceShareAssociations (list) --

      Information about the associations.

      • (dict) --

        Describes an association with a resource share.

        • resourceShareArn (string) --

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

        • resourceShareName (string) --

          The name of the resource share.

        • associatedEntity (string) --

          The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

        • associationType (string) --

          The association type.

        • status (string) --

          The status of the association.

        • statusMessage (string) --

          A message about the status of the association.

        • creationTime (datetime) --

          The time when the association was created.

        • lastUpdatedTime (datetime) --

          The time when the association was last updated.

        • external (boolean) --

          Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • clientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Exceptions

disassociate_resource_share_permission(**kwargs)

Disassociates an AWS RAM permission from a resource share.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_resource_share_permission(
    resourceShareArn='string',
    permissionArn='string',
    clientToken='string'
)
Parameters
  • resourceShareArn (string) --

    [REQUIRED]

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

  • permissionArn (string) --

    [REQUIRED]

    The ARN of the permission to disassociate from the resource share.

  • clientToken (string) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Return type

dict

Returns

Response Syntax

{
    'returnValue': True|False,
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • returnValue (boolean) --

      Indicates whether the request succeeded.

    • clientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Exceptions

enable_sharing_with_aws_organization()

Enables resource sharing within your AWS Organization.

The caller must be the master account for the AWS Organization.

See also: AWS API Documentation

Request Syntax

response = client.enable_sharing_with_aws_organization()
Return type
dict
Returns
Response Syntax
{
    'returnValue': True|False
}

Response Structure

  • (dict) --
    • returnValue (boolean) --

      Indicates whether the request succeeded.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_permission(**kwargs)

Gets the contents of an AWS RAM permission in JSON format.

See also: AWS API Documentation

Request Syntax

response = client.get_permission(
    permissionArn='string',
    permissionVersion=123
)
Parameters
  • permissionArn (string) --

    [REQUIRED]

    The ARN of the permission.

  • permissionVersion (integer) -- The identifier for the version of the permission.
Return type

dict

Returns

Response Syntax

{
    'permission': {
        'arn': 'string',
        'version': 'string',
        'defaultVersion': True|False,
        'name': 'string',
        'resourceType': 'string',
        'permission': 'string',
        'creationTime': datetime(2015, 1, 1),
        'lastUpdatedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • permission (dict) --

      Information about the permission.

      • arn (string) --

        The ARN of the permission.

      • version (string) --

        The identifier for the version of the permission.

      • defaultVersion (boolean) --

        The identifier for the version of the permission that is set as the default version.

      • name (string) --

        The name of the permission.

      • resourceType (string) --

        The resource type to which the permission applies.

      • permission (string) --

        The permission's effect and actions in JSON format. The effect indicates whether the actions are allowed or denied. The actions list the API actions to which the principal is granted or denied access.

      • creationTime (datetime) --

        The date and time when the permission was created.

      • lastUpdatedTime (datetime) --

        The date and time when the permission was last updated.

Exceptions

get_resource_policies(**kwargs)

Gets the policies for the specified resources that you own and have shared.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_policies(
    resourceArns=[
        'string',
    ],
    principal='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • resourceArns (list) --

    [REQUIRED]

    The Amazon Resource Names (ARN) of the resources.

    • (string) --
  • principal (string) -- The principal.
  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'policies': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • policies (list) --

      A key policy document, in JSON format.

      • (string) --
    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

get_resource_share_associations(**kwargs)

Gets the resources or principals for the resource shares that you own.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_share_associations(
    associationType='PRINCIPAL'|'RESOURCE',
    resourceShareArns=[
        'string',
    ],
    resourceArn='string',
    principal='string',
    associationStatus='ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
    nextToken='string',
    maxResults=123
)
Parameters
  • associationType (string) --

    [REQUIRED]

    The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share.

  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • resourceArn (string) -- The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL .
  • principal (string) -- The principal. You cannot specify this parameter if the association type is RESOURCE .
  • associationStatus (string) -- The association status.
  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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) --

      Information about the associations.

      • (dict) --

        Describes an association with a resource share.

        • resourceShareArn (string) --

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

        • resourceShareName (string) --

          The name of the resource share.

        • associatedEntity (string) --

          The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

        • associationType (string) --

          The association type.

        • status (string) --

          The status of the association.

        • statusMessage (string) --

          A message about the status of the association.

        • creationTime (datetime) --

          The time when the association was created.

        • lastUpdatedTime (datetime) --

          The time when the association was last updated.

        • external (boolean) --

          Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

get_resource_share_invitations(**kwargs)

Gets the invitations for resource sharing that you've received.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_share_invitations(
    resourceShareInvitationArns=[
        'string',
    ],
    resourceShareArns=[
        'string',
    ],
    nextToken='string',
    maxResults=123
)
Parameters
  • resourceShareInvitationArns (list) --

    The Amazon Resource Names (ARN) of the invitations.

    • (string) --
  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'resourceShareInvitations': [
        {
            'resourceShareInvitationArn': 'string',
            'resourceShareName': 'string',
            'resourceShareArn': 'string',
            'senderAccountId': 'string',
            'receiverAccountId': 'string',
            'invitationTimestamp': datetime(2015, 1, 1),
            'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'EXPIRED',
            '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) --

    • resourceShareInvitations (list) --

      Information about the invitations.

      • (dict) --

        Describes an invitation to join a resource share.

        • resourceShareInvitationArn (string) --

          The Amazon Resource Name (ARN) of the invitation.

        • resourceShareName (string) --

          The name of the resource share.

        • resourceShareArn (string) --

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

        • senderAccountId (string) --

          The ID of the AWS account that sent the invitation.

        • receiverAccountId (string) --

          The ID of the AWS account that received the invitation.

        • invitationTimestamp (datetime) --

          The date and time when the invitation was sent.

        • status (string) --

          The status of the invitation.

        • resourceShareAssociations (list) --

          To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources .

          • (dict) --

            Describes an association with a resource share.

            • resourceShareArn (string) --

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

            • resourceShareName (string) --

              The name of the resource share.

            • associatedEntity (string) --

              The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

            • associationType (string) --

              The association type.

            • status (string) --

              The status of the association.

            • statusMessage (string) --

              A message about the status of the association.

            • creationTime (datetime) --

              The time when the association was created.

            • lastUpdatedTime (datetime) --

              The time when the association was last updated.

            • external (boolean) --

              Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

get_resource_shares(**kwargs)

Gets the resource shares that you own or the resource shares that are shared with you.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_shares(
    resourceShareArns=[
        'string',
    ],
    resourceShareStatus='PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    name='string',
    tagFilters=[
        {
            'tagKey': 'string',
            'tagValues': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)
Parameters
  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • resourceShareStatus (string) -- The status of the resource share.
  • resourceOwner (string) --

    [REQUIRED]

    The type of owner.

  • name (string) -- The name of the resource share.
  • tagFilters (list) --

    One or more tag filters.

    • (dict) --

      Used to filter information based on tags.

      • tagKey (string) --

        The tag key.

      • tagValues (list) --

        The tag values.

        • (string) --
  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'resourceShares': [
        {
            'resourceShareArn': 'string',
            'name': 'string',
            'owningAccountId': 'string',
            'allowExternalPrincipals': True|False,
            'status': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
            'statusMessage': 'string',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • resourceShares (list) --

      Information about the resource shares.

      • (dict) --

        Describes a resource share.

        • resourceShareArn (string) --

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

        • name (string) --

          The name of the resource share.

        • owningAccountId (string) --

          The ID of the AWS account that owns the resource share.

        • allowExternalPrincipals (boolean) --

          Indicates whether principals outside your AWS organization can be associated with a resource share.

        • status (string) --

          The status of the resource share.

        • statusMessage (string) --

          A message about the status of the resource share.

        • tags (list) --

          The tags for the resource share.

          • (dict) --

            Information about a tag.

            • key (string) --

              The key of the tag.

            • value (string) --

              The value of the tag.

        • creationTime (datetime) --

          The time when the resource share was created.

        • lastUpdatedTime (datetime) --

          The time when the resource share was last updated.

        • featureSet (string) --

          Indicates how the resource share was created. Possible values include:

          • CREATED_FROM_POLICY - Indicates that the resource share was created from an AWS Identity and Access Management (AWS IAM) policy attached to a resource. These resource shares are visible only to the AWS account that created it. They cannot be modified in AWS RAM.
          • PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy .
          • STANDARD - Indicates that the resource share was created in AWS RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in AWS RAM.
    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_pending_invitation_resources(**kwargs)

Lists the resources in a resource share that is shared with you but that the invitation is still pending for.

See also: AWS API Documentation

Request Syntax

response = client.list_pending_invitation_resources(
    resourceShareInvitationArn='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • resourceShareInvitationArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the invitation.

  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'resources': [
        {
            'arn': 'string',
            'type': 'string',
            'resourceShareArn': 'string',
            'resourceGroupArn': 'string',
            'status': 'AVAILABLE'|'ZONAL_RESOURCE_INACCESSIBLE'|'LIMIT_EXCEEDED'|'UNAVAILABLE'|'PENDING',
            'statusMessage': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • resources (list) --

      Information about the resources included the resource share.

      • (dict) --

        Describes a resource associated with a resource share.

        • arn (string) --

          The Amazon Resource Name (ARN) of the resource.

        • type (string) --

          The resource type.

        • resourceShareArn (string) --

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

        • resourceGroupArn (string) --

          The ARN of the resource group. This value is returned only if the resource is a resource group.

        • status (string) --

          The status of the resource.

        • statusMessage (string) --

          A message about the status of the resource.

        • creationTime (datetime) --

          The time when the resource was associated with the resource share.

        • lastUpdatedTime (datetime) --

          The time when the association was last updated.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_permissions(**kwargs)

Lists the AWS RAM permissions.

See also: AWS API Documentation

Request Syntax

response = client.list_permissions(
    resourceType='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • resourceType (string) -- Specifies the resource type for which to list permissions. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet .
  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'permissions': [
        {
            'arn': 'string',
            'version': 'string',
            'defaultVersion': True|False,
            'name': 'string',
            'resourceType': 'string',
            'status': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • permissions (list) --

      Information about the permissions.

      • (dict) --

        Information about a permission that is associated with a resource share.

        • arn (string) --

          The ARN of the permission.

        • version (string) --

          The identifier for the version of the permission.

        • defaultVersion (boolean) --

          The identifier for the version of the permission that is set as the default version.

        • name (string) --

          The name of the permission.

        • resourceType (string) --

          The type of resource to which the permission applies.

        • status (string) --

          The current status of the permission.

        • creationTime (datetime) --

          The date and time when the permission was created.

        • lastUpdatedTime (datetime) --

          The date and time when the permission was last updated.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_principals(**kwargs)

Lists the principals that you have shared resources with or that have shared resources with you.

See also: AWS API Documentation

Request Syntax

response = client.list_principals(
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    resourceArn='string',
    principals=[
        'string',
    ],
    resourceType='string',
    resourceShareArns=[
        'string',
    ],
    nextToken='string',
    maxResults=123
)
Parameters
  • resourceOwner (string) --

    [REQUIRED]

    The type of owner.

  • resourceArn (string) -- The Amazon Resource Name (ARN) of the resource.
  • principals (list) --

    The principals.

    • (string) --
  • resourceType (string) --

    The resource type.

    Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule

  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'principals': [
        {
            'id': 'string',
            'resourceShareArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'external': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • principals (list) --

      The principals.

      • (dict) --

        Describes a principal for use with AWS Resource Access Manager.

        • id (string) --

          The ID of the principal.

        • resourceShareArn (string) --

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

        • creationTime (datetime) --

          The time when the principal was associated with the resource share.

        • lastUpdatedTime (datetime) --

          The time when the association was last updated.

        • external (boolean) --

          Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_resource_share_permissions(**kwargs)

Lists the AWS RAM permissions that are associated with a resource share.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_share_permissions(
    resourceShareArn='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • resourceShareArn (string) --

    [REQUIRED]

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

  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'permissions': [
        {
            'arn': 'string',
            'version': 'string',
            'defaultVersion': True|False,
            'name': 'string',
            'resourceType': 'string',
            'status': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • permissions (list) --

      The permissions associated with the resource share.

      • (dict) --

        Information about a permission that is associated with a resource share.

        • arn (string) --

          The ARN of the permission.

        • version (string) --

          The identifier for the version of the permission.

        • defaultVersion (boolean) --

          The identifier for the version of the permission that is set as the default version.

        • name (string) --

          The name of the permission.

        • resourceType (string) --

          The type of resource to which the permission applies.

        • status (string) --

          The current status of the permission.

        • creationTime (datetime) --

          The date and time when the permission was created.

        • lastUpdatedTime (datetime) --

          The date and time when the permission was last updated.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_resource_types(**kwargs)

Lists the shareable resource types supported by AWS RAM.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_types(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'resourceTypes': [
        {
            'resourceType': 'string',
            'serviceName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • resourceTypes (list) --

      The shareable resource types supported by AWS RAM.

      • (dict) --

        Information about the shareable resource types and the AWS services to which they belong.

        • resourceType (string) --

          The shareable resource types.

        • serviceName (string) --

          The name of the AWS services to which the resources belong.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_resources(**kwargs)

Lists the resources that you added to a resource shares or the resources that are shared with you.

See also: AWS API Documentation

Request Syntax

response = client.list_resources(
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    principal='string',
    resourceType='string',
    resourceArns=[
        'string',
    ],
    resourceShareArns=[
        'string',
    ],
    nextToken='string',
    maxResults=123
)
Parameters
  • resourceOwner (string) --

    [REQUIRED]

    The type of owner.

  • principal (string) -- The principal.
  • resourceType (string) --

    The resource type.

    Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule

  • resourceArns (list) --

    The Amazon Resource Names (ARN) of the resources.

    • (string) --
  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • nextToken (string) -- The token for the next page of results.
  • maxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'resources': [
        {
            'arn': 'string',
            'type': 'string',
            'resourceShareArn': 'string',
            'resourceGroupArn': 'string',
            'status': 'AVAILABLE'|'ZONAL_RESOURCE_INACCESSIBLE'|'LIMIT_EXCEEDED'|'UNAVAILABLE'|'PENDING',
            'statusMessage': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • resources (list) --

      Information about the resources.

      • (dict) --

        Describes a resource associated with a resource share.

        • arn (string) --

          The Amazon Resource Name (ARN) of the resource.

        • type (string) --

          The resource type.

        • resourceShareArn (string) --

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

        • resourceGroupArn (string) --

          The ARN of the resource group. This value is returned only if the resource is a resource group.

        • status (string) --

          The status of the resource.

        • statusMessage (string) --

          A message about the status of the resource.

        • creationTime (datetime) --

          The time when the resource was associated with the resource share.

        • lastUpdatedTime (datetime) --

          The time when the association was last updated.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

promote_resource_share_created_from_policy(**kwargs)

Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.

Use this API action to promote the resource share. When you promote the resource share, it becomes:

  • Visible to all principals that it is shared with.
  • Modifiable in AWS RAM.

See also: AWS API Documentation

Request Syntax

response = client.promote_resource_share_created_from_policy(
    resourceShareArn='string'
)
Parameters
resourceShareArn (string) --

[REQUIRED]

The ARN of the resource share to promote.

Return type
dict
Returns
Response Syntax
{
    'returnValue': True|False
}

Response Structure

  • (dict) --
    • returnValue (boolean) --

      Indicates whether the request succeeded.

Exceptions

reject_resource_share_invitation(**kwargs)

Rejects an invitation to a resource share from another AWS account.

See also: AWS API Documentation

Request Syntax

response = client.reject_resource_share_invitation(
    resourceShareInvitationArn='string',
    clientToken='string'
)
Parameters
  • resourceShareInvitationArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the invitation.

  • clientToken (string) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Return type

dict

Returns

Response Syntax

{
    'resourceShareInvitation': {
        'resourceShareInvitationArn': 'string',
        'resourceShareName': 'string',
        'resourceShareArn': 'string',
        'senderAccountId': 'string',
        'receiverAccountId': 'string',
        'invitationTimestamp': datetime(2015, 1, 1),
        'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'EXPIRED',
        '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
            },
        ]
    },
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • resourceShareInvitation (dict) --

      Information about the invitation.

      • resourceShareInvitationArn (string) --

        The Amazon Resource Name (ARN) of the invitation.

      • resourceShareName (string) --

        The name of the resource share.

      • resourceShareArn (string) --

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

      • senderAccountId (string) --

        The ID of the AWS account that sent the invitation.

      • receiverAccountId (string) --

        The ID of the AWS account that received the invitation.

      • invitationTimestamp (datetime) --

        The date and time when the invitation was sent.

      • status (string) --

        The status of the invitation.

      • resourceShareAssociations (list) --

        To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources .

        • (dict) --

          Describes an association with a resource share.

          • resourceShareArn (string) --

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

          • resourceShareName (string) --

            The name of the resource share.

          • associatedEntity (string) --

            The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

          • associationType (string) --

            The association type.

          • status (string) --

            The status of the association.

          • statusMessage (string) --

            A message about the status of the association.

          • creationTime (datetime) --

            The time when the association was created.

          • lastUpdatedTime (datetime) --

            The time when the association was last updated.

          • external (boolean) --

            Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • clientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Exceptions

tag_resource(**kwargs)

Adds the specified tags to the specified resource share that you own.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceShareArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • resourceShareArn (string) --

    [REQUIRED]

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

  • tags (list) --

    [REQUIRED]

    One or more tags.

    • (dict) --

      Information about a tag.

      • key (string) --

        The key of the tag.

      • value (string) --

        The value of the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes the specified tags from the specified resource share that you own.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceShareArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceShareArn (string) --

    [REQUIRED]

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

  • tagKeys (list) --

    [REQUIRED]

    The tag keys of the tags to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_resource_share(**kwargs)

Updates the specified resource share that you own.

See also: AWS API Documentation

Request Syntax

response = client.update_resource_share(
    resourceShareArn='string',
    name='string',
    allowExternalPrincipals=True|False,
    clientToken='string'
)
Parameters
  • resourceShareArn (string) --

    [REQUIRED]

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

  • name (string) -- The name of the resource share.
  • allowExternalPrincipals (boolean) -- Indicates whether principals outside your AWS organization can be associated with a resource share.
  • clientToken (string) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Return type

dict

Returns

Response Syntax

{
    'resourceShare': {
        'resourceShareArn': 'string',
        'name': 'string',
        'owningAccountId': 'string',
        'allowExternalPrincipals': True|False,
        'status': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
        'statusMessage': 'string',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'creationTime': datetime(2015, 1, 1),
        'lastUpdatedTime': datetime(2015, 1, 1),
        'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD'
    },
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • resourceShare (dict) --

      Information about the resource share.

      • resourceShareArn (string) --

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

      • name (string) --

        The name of the resource share.

      • owningAccountId (string) --

        The ID of the AWS account that owns the resource share.

      • allowExternalPrincipals (boolean) --

        Indicates whether principals outside your AWS organization can be associated with a resource share.

      • status (string) --

        The status of the resource share.

      • statusMessage (string) --

        A message about the status of the resource share.

      • tags (list) --

        The tags for the resource share.

        • (dict) --

          Information about a tag.

          • key (string) --

            The key of the tag.

          • value (string) --

            The value of the tag.

      • creationTime (datetime) --

        The time when the resource share was created.

      • lastUpdatedTime (datetime) --

        The time when the resource share was last updated.

      • featureSet (string) --

        Indicates how the resource share was created. Possible values include:

        • CREATED_FROM_POLICY - Indicates that the resource share was created from an AWS Identity and Access Management (AWS IAM) policy attached to a resource. These resource shares are visible only to the AWS account that created it. They cannot be modified in AWS RAM.
        • PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy .
        • STANDARD - Indicates that the resource share was created in AWS RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in AWS RAM.
    • clientToken (string) --

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class RAM.Client.exceptions.IdempotentParameterMismatchException

A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

Example

try:
  ...
except client.exceptions.IdempotentParameterMismatchException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.InvalidClientTokenException

A client token is not valid.

Example

try:
  ...
except client.exceptions.InvalidClientTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A client token is not valid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.InvalidMaxResultsException

The specified value for MaxResults is not valid.

Example

try:
  ...
except client.exceptions.InvalidMaxResultsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified value for MaxResults is not valid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.InvalidNextTokenException

The specified value for NextToken is not valid.

Example

try:
  ...
except client.exceptions.InvalidNextTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified value for NextToken is not valid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.InvalidParameterException

A parameter is not valid.

Example

try:
  ...
except client.exceptions.InvalidParameterException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A parameter is not valid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.InvalidResourceTypeException

The specified resource type is not valid.

Example

try:
  ...
except client.exceptions.InvalidResourceTypeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource type is not valid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.InvalidStateTransitionException

The requested state transition is not valid.

Example

try:
  ...
except client.exceptions.InvalidStateTransitionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested state transition is not valid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.MalformedArnException

The format of an Amazon Resource Name (ARN) is not valid.

Example

try:
  ...
except client.exceptions.MalformedArnException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The format of an Amazon Resource Name (ARN) is not valid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.MissingRequiredParameterException

A required input parameter is missing.

Example

try:
  ...
except client.exceptions.MissingRequiredParameterException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A required input parameter is missing.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.OperationNotPermittedException

The requested operation is not permitted.

Example

try:
  ...
except client.exceptions.OperationNotPermittedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested operation is not permitted.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.ResourceArnNotFoundException

An Amazon Resource Name (ARN) was not found.

Example

try:
  ...
except client.exceptions.ResourceArnNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An Amazon Resource Name (ARN) was not found.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.ResourceShareInvitationAlreadyAcceptedException

The invitation was already accepted.

Example

try:
  ...
except client.exceptions.ResourceShareInvitationAlreadyAcceptedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The invitation was already accepted.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.ResourceShareInvitationAlreadyRejectedException

The invitation was already rejected.

Example

try:
  ...
except client.exceptions.ResourceShareInvitationAlreadyRejectedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The invitation was already rejected.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.ResourceShareInvitationArnNotFoundException

The Amazon Resource Name (ARN) for an invitation was not found.

Example

try:
  ...
except client.exceptions.ResourceShareInvitationArnNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The Amazon Resource Name (ARN) for an invitation was not found.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.ResourceShareInvitationExpiredException

The invitation is expired.

Example

try:
  ...
except client.exceptions.ResourceShareInvitationExpiredException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The invitation is expired.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.ResourceShareLimitExceededException

The requested resource share exceeds the limit for your account.

Example

try:
  ...
except client.exceptions.ResourceShareLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested resource share exceeds the limit for your account.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.ServerInternalException

The service could not respond to the request due to an internal problem.

Example

try:
  ...
except client.exceptions.ServerInternalException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service could not respond to the request due to an internal problem.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.ServiceUnavailableException

The service is not available.

Example

try:
  ...
except client.exceptions.ServiceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service is not available.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.TagLimitExceededException

The requested tags exceed the limit for your account.

Example

try:
  ...
except client.exceptions.TagLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested tags exceed the limit for your account.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.TagPolicyViolationException

The specified tag is a reserved word and cannot be used.

Example

try:
  ...
except client.exceptions.TagPolicyViolationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified tag is a reserved word and cannot be used.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RAM.Client.exceptions.UnknownResourceException

A specified resource was not found.

Example

try:
  ...
except client.exceptions.UnknownResourceException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A specified resource was not found.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class RAM.Paginator.GetResourcePolicies
paginator = client.get_paginator('get_resource_policies')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceArns=[
        'string',
    ],
    principal='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • resourceArns (list) --

    [REQUIRED]

    The Amazon Resource Names (ARN) of the resources.

    • (string) --
  • principal (string) -- The principal.
  • 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

{
    'policies': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • policies (list) --

      A key policy document, in JSON format.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

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]

    The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share.

  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • resourceArn (string) -- The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL .
  • principal (string) -- The principal. You cannot specify this parameter if the association type is RESOURCE .
  • associationStatus (string) -- The association 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) --

      Information about the associations.

      • (dict) --

        Describes an association with a resource share.

        • resourceShareArn (string) --

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

        • resourceShareName (string) --

          The name of the resource share.

        • associatedEntity (string) --

          The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

        • associationType (string) --

          The association type.

        • status (string) --

          The status of the association.

        • statusMessage (string) --

          A message about the status of the association.

        • creationTime (datetime) --

          The time when the association was created.

        • lastUpdatedTime (datetime) --

          The time when the association was last updated.

        • external (boolean) --

          Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • NextToken (string) --

      A token to resume pagination.

class RAM.Paginator.GetResourceShareInvitations
paginator = client.get_paginator('get_resource_share_invitations')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceShareInvitationArns=[
        'string',
    ],
    resourceShareArns=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • resourceShareInvitationArns (list) --

    The Amazon Resource Names (ARN) of the invitations.

    • (string) --
  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • 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

{
    'resourceShareInvitations': [
        {
            'resourceShareInvitationArn': 'string',
            'resourceShareName': 'string',
            'resourceShareArn': 'string',
            'senderAccountId': 'string',
            'receiverAccountId': 'string',
            'invitationTimestamp': datetime(2015, 1, 1),
            'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'EXPIRED',
            '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) --

    • resourceShareInvitations (list) --

      Information about the invitations.

      • (dict) --

        Describes an invitation to join a resource share.

        • resourceShareInvitationArn (string) --

          The Amazon Resource Name (ARN) of the invitation.

        • resourceShareName (string) --

          The name of the resource share.

        • resourceShareArn (string) --

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

        • senderAccountId (string) --

          The ID of the AWS account that sent the invitation.

        • receiverAccountId (string) --

          The ID of the AWS account that received the invitation.

        • invitationTimestamp (datetime) --

          The date and time when the invitation was sent.

        • status (string) --

          The status of the invitation.

        • resourceShareAssociations (list) --

          To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources .

          • (dict) --

            Describes an association with a resource share.

            • resourceShareArn (string) --

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

            • resourceShareName (string) --

              The name of the resource share.

            • associatedEntity (string) --

              The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

            • associationType (string) --

              The association type.

            • status (string) --

              The status of the association.

            • statusMessage (string) --

              A message about the status of the association.

            • creationTime (datetime) --

              The time when the association was created.

            • lastUpdatedTime (datetime) --

              The time when the association was last updated.

            • external (boolean) --

              Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • NextToken (string) --

      A token to resume pagination.

class RAM.Paginator.GetResourceShares
paginator = client.get_paginator('get_resource_shares')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceShareArns=[
        'string',
    ],
    resourceShareStatus='PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    name='string',
    tagFilters=[
        {
            'tagKey': 'string',
            'tagValues': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • resourceShareStatus (string) -- The status of the resource share.
  • resourceOwner (string) --

    [REQUIRED]

    The type of owner.

  • name (string) -- The name of the resource share.
  • tagFilters (list) --

    One or more tag filters.

    • (dict) --

      Used to filter information based on tags.

      • tagKey (string) --

        The tag key.

      • tagValues (list) --

        The tag values.

        • (string) --
  • 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

{
    'resourceShares': [
        {
            'resourceShareArn': 'string',
            'name': 'string',
            'owningAccountId': 'string',
            'allowExternalPrincipals': True|False,
            'status': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
            'statusMessage': 'string',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • resourceShares (list) --

      Information about the resource shares.

      • (dict) --

        Describes a resource share.

        • resourceShareArn (string) --

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

        • name (string) --

          The name of the resource share.

        • owningAccountId (string) --

          The ID of the AWS account that owns the resource share.

        • allowExternalPrincipals (boolean) --

          Indicates whether principals outside your AWS organization can be associated with a resource share.

        • status (string) --

          The status of the resource share.

        • statusMessage (string) --

          A message about the status of the resource share.

        • tags (list) --

          The tags for the resource share.

          • (dict) --

            Information about a tag.

            • key (string) --

              The key of the tag.

            • value (string) --

              The value of the tag.

        • creationTime (datetime) --

          The time when the resource share was created.

        • lastUpdatedTime (datetime) --

          The time when the resource share was last updated.

        • featureSet (string) --

          Indicates how the resource share was created. Possible values include:

          • CREATED_FROM_POLICY - Indicates that the resource share was created from an AWS Identity and Access Management (AWS IAM) policy attached to a resource. These resource shares are visible only to the AWS account that created it. They cannot be modified in AWS RAM.
          • PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy .
          • STANDARD - Indicates that the resource share was created in AWS RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in AWS RAM.
    • NextToken (string) --

      A token to resume pagination.

class RAM.Paginator.ListPrincipals
paginator = client.get_paginator('list_principals')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    resourceArn='string',
    principals=[
        'string',
    ],
    resourceType='string',
    resourceShareArns=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • resourceOwner (string) --

    [REQUIRED]

    The type of owner.

  • resourceArn (string) -- The Amazon Resource Name (ARN) of the resource.
  • principals (list) --

    The principals.

    • (string) --
  • resourceType (string) --

    The resource type.

    Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule

  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • 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

{
    'principals': [
        {
            'id': 'string',
            'resourceShareArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'external': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • principals (list) --

      The principals.

      • (dict) --

        Describes a principal for use with AWS Resource Access Manager.

        • id (string) --

          The ID of the principal.

        • resourceShareArn (string) --

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

        • creationTime (datetime) --

          The time when the principal was associated with the resource share.

        • lastUpdatedTime (datetime) --

          The time when the association was last updated.

        • external (boolean) --

          Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    • NextToken (string) --

      A token to resume pagination.

class RAM.Paginator.ListResources
paginator = client.get_paginator('list_resources')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    principal='string',
    resourceType='string',
    resourceArns=[
        'string',
    ],
    resourceShareArns=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • resourceOwner (string) --

    [REQUIRED]

    The type of owner.

  • principal (string) -- The principal.
  • resourceType (string) --

    The resource type.

    Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule

  • resourceArns (list) --

    The Amazon Resource Names (ARN) of the resources.

    • (string) --
  • resourceShareArns (list) --

    The Amazon Resource Names (ARN) of the resource shares.

    • (string) --
  • 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

{
    'resources': [
        {
            'arn': 'string',
            'type': 'string',
            'resourceShareArn': 'string',
            'resourceGroupArn': 'string',
            'status': 'AVAILABLE'|'ZONAL_RESOURCE_INACCESSIBLE'|'LIMIT_EXCEEDED'|'UNAVAILABLE'|'PENDING',
            'statusMessage': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • resources (list) --

      Information about the resources.

      • (dict) --

        Describes a resource associated with a resource share.

        • arn (string) --

          The Amazon Resource Name (ARN) of the resource.

        • type (string) --

          The resource type.

        • resourceShareArn (string) --

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

        • resourceGroupArn (string) --

          The ARN of the resource group. This value is returned only if the resource is a resource group.

        • status (string) --

          The status of the resource.

        • statusMessage (string) --

          A message about the status of the resource.

        • creationTime (datetime) --

          The time when the resource was associated with the resource share.

        • lastUpdatedTime (datetime) --

          The time when the association was last updated.

    • NextToken (string) --

      A token to resume pagination.