RAM / Client / update_resource_share

update_resource_share

RAM.Client.update_resource_share(**kwargs)

Modifies some of the properties of the specified resource share.

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]

  Specifies the Amazon Resoure Name (ARN) of the resource share that you want to modify.

• name (string) – If specified, the new name that you want to attach to the resource share.

• allowExternalPrincipals (boolean) – Specifies whether principals outside your organization in Organizations can be associated with a resource share.

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

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 Resoure Name (ARN) of the resource share

    • name (string) –

      The name of the resource share.

    • owningAccountId (string) –

      The ID of the Amazon Web Services account that owns the resource share.

    • allowExternalPrincipals (boolean) –

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

    • status (string) –

      The current status of the resource share.

    • statusMessage (string) –

      A message about the status of the resource share.

    • tags (list) –

      The tag key and value pairs attached to the resource share.

      • (dict) –

        A structure containing a tag. A tag is metadata that you can attach to your resources to help organize and categorize them. You can also use them to help you secure your resources. For more information, see Controlling access to Amazon Web Services resources using tags.

        For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

        • key (string) –

          The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.

        • value (string) –

          The string value attached to the tag. The value can be an empty string. Key values are case sensitive.

    • creationTime (datetime) –

      The date and time when the resource share was created.

    • lastUpdatedTime (datetime) –

      The date and 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 Identity and Access Management (IAM) resource-based permission policy attached to the resource. This type of resource share is visible only to the Amazon Web Services account that created it. You can’t modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

      • 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 RAM using the console or APIs. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs.

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

• RAM.Client.exceptions.UnknownResourceException

• RAM.Client.exceptions.MalformedArnException

• RAM.Client.exceptions.InvalidClientTokenException

• RAM.Client.exceptions.InvalidParameterException

• RAM.Client.exceptions.OperationNotPermittedException

• RAM.Client.exceptions.ServerInternalException

• RAM.Client.exceptions.ServiceUnavailableException