RAM / Client / disassociate_resource_share

disassociate_resource_share#

RAM.Client.disassociate_resource_share(**kwargs)#

Removes the specified principals or resources from participating in 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]

    Specifies Amazon Resource Name (ARN) of the resource share that you want to remove resources or principals from.

  • resourceArns (list) –

    Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals associated with the resource share.

    • (string) –

  • principals (list) –

    Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.

    You can include the following values:

    • An Amazon Web Services account ID, for example: 123456789012

    • An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

    • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

    • An ARN of an IAM role, for example: iam::123456789012:role/rolename

    • An ARN of an IAM user, for example: iam::123456789012user/username

    Note

    Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

    • (string) –

  • clientToken (string) –

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don’t provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

      An array of objects with information about the updated associations for this resource share.

      • (dict) –

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

        • resourceShareArn (string) –

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

        • resourceShareName (string) –

          The name of the resource share.

        • associatedEntity (string) –

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

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

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

            • The ID of an Amazon Web Services account

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

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

            • The ARN of an IAM role

            • The ARN of an IAM user

        • associationType (string) –

          The type of entity included in this association.

        • status (string) –

          The current status of the association.

        • statusMessage (string) –

          A message about the status of the association.

        • creationTime (datetime) –

          The date and time when the association was created.

        • lastUpdatedTime (datetime) –

          The date and time when the association was last updated.

        • external (boolean) –

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

    • clientToken (string) –

      The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Exceptions

  • RAM.Client.exceptions.IdempotentParameterMismatchException

  • RAM.Client.exceptions.ResourceShareLimitExceededException

  • RAM.Client.exceptions.MalformedArnException

  • RAM.Client.exceptions.InvalidStateTransitionException

  • RAM.Client.exceptions.InvalidClientTokenException

  • RAM.Client.exceptions.InvalidParameterException

  • RAM.Client.exceptions.OperationNotPermittedException

  • RAM.Client.exceptions.ServerInternalException

  • RAM.Client.exceptions.ServiceUnavailableException

  • RAM.Client.exceptions.UnknownResourceException