AWS API Changes

2026/02/27 - AWS Resource Access Manager - 3 updated api methods

Changes Resource owners can now specify ResourceShareConfiguration request parameter for CreateResourceShare API including RetainSharingOnAccountLeaveOrganization boolean parameter

CreateResourceShare (updated)

Link ¶
Changes (request, response)
Request

{'resourceShareConfiguration': {'retainSharingOnAccountLeaveOrganization': 'boolean'}}

Response

{'resourceShare': {'resourceShareConfiguration': {'retainSharingOnAccountLeaveOrganization': 'boolean'}}}

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, the permissions to grant those principals, and optionally source constraints to enhance security for service principal sharing.

See also: AWS API Documentation

Request Syntax

client.create_resource_share(
    name='string',
    resourceArns=[
        'string',
    ],
    principals=[
        'string',
    ],
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    allowExternalPrincipals=True|False,
    clientToken='string',
    permissionArns=[
        'string',
    ],
    sources=[
        'string',
    ],
    resourceShareConfiguration={
        'retainSharingOnAccountLeaveOrganization': True|False
    }
)

type name:

string

param name:

[REQUIRED]

Specifies the name of the resource share.

type resourceArns:

list

param resourceArns:

Specifies a list of one or more ARNs of the resources to associate with the resource share.

(string) --

type principals:

list

param principals:

Specifies a list of one or more principals to associate with the 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
A service principal name, for example: service-id.amazonaws.com

(string) --

type tags:

list

param tags:

Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with 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.

type allowExternalPrincipals:

boolean

param allowExternalPrincipals:

Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of true lets you share with individual Amazon Web Services accounts that are not in your organization. A value of false only has meaning if your account is a member of an Amazon Web Services Organization. The default value is true.

type clientToken:

string

param clientToken:

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.

type permissionArns:

list

param permissionArns:

Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.

(string) --

type sources:

list

param sources:

Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) that limit when service principals can access resources in this resource share. When a service principal attempts to access a shared resource, validation is performed to ensure the request originates from one of the specified sources. This helps prevent confused deputy attacks by applying constraints on where service principals can access resources from.

(string) --

type resourceShareConfiguration:

dict

param resourceShareConfiguration:

Specifies the configuration of this resource share.

retainSharingOnAccountLeaveOrganization (boolean) --

Specifies whether the consumer account retains access to the resource share after leaving the organization.

rtype:

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',
        'resourceShareConfiguration': {
            'retainSharingOnAccountLeaveOrganization': True|False
        }
    },
    'clientToken': 'string'
}

Response Structure

(dict) --
- resourceShare (dict) --
  
  An object with information about the new 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 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.
    - True – the resource share can be shared with any Amazon Web Services account.
    - False – the resource share can be shared with only accounts in the same organization as the account that owns the 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 what features are available for this resource share. This parameter can have one of the following values:
    - STANDARD – A resource share that supports all functionality. 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. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    - CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. 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 – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
  - resourceShareConfiguration (dict) --
    
    The configuration of the resource share
    - retainSharingOnAccountLeaveOrganization (boolean) --
      
      Specifies whether the consumer account retains access to the resource share after leaving the organization.
- 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.

GetResourceShares (updated)

Link ¶
Changes (response)

{'resourceShares': {'resourceShareConfiguration': {'retainSharingOnAccountLeaveOrganization': 'boolean'}}}

Retrieves details about the resource shares that you own or that are shared with you.

See also: AWS API Documentation

Request Syntax

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,
    permissionArn='string',
    permissionVersion=123
)

type resourceShareArns:

list

param resourceShareArns:

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

(string) --

type resourceShareStatus:

string

param resourceShareStatus:

Specifies that you want to retrieve details of only those resource shares that have this status.

type resourceOwner:

string

param resourceOwner:

[REQUIRED]

Specifies that you want to retrieve details of only those resource shares that match the following:

SELF – resource shares that your account shares with other accounts
OTHER-ACCOUNTS – resource shares that other accounts share with your account

type name:

string

param name:

Specifies the name of an individual resource share that you want to retrieve details about.

type tagFilters:

list

param tagFilters:

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

(dict) --

A tag key and optional list of possible values that you can use to filter results for tagged resources.

Note

Multiple tag filters are evaluated as an OR condition.
- tagKey (string) --
  
  The tag key. This must have a valid string value and can't be empty.
- tagValues (list) --
  
  A list of zero or more tag values. If no values are provided, then the filter matches any tag with the specified key, regardless of its value.
  - (string) --

type nextToken:

string

param nextToken:

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

type maxResults:

integer

param maxResults:

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

type permissionArn:

string

param permissionArn:

Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

type permissionVersion:

integer

param permissionVersion:

Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

rtype:

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',
            'resourceShareConfiguration': {
                'retainSharingOnAccountLeaveOrganization': True|False
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- resourceShares (list) --
  
  An array of objects that contain the information about the resource shares.
  - (dict) --
    
    Describes a resource share in RAM.
    - 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 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.
      - True – the resource share can be shared with any Amazon Web Services account.
      - False – the resource share can be shared with only accounts in the same organization as the account that owns the 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 what features are available for this resource share. This parameter can have one of the following values:
      - STANDARD – A resource share that supports all functionality. 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. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
      - CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. 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 – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
    - resourceShareConfiguration (dict) --
      
      The configuration of the resource share
      - retainSharingOnAccountLeaveOrganization (boolean) --
        
        Specifies whether the consumer account retains access to the resource share after leaving the organization.
- nextToken (string) --
  
  If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

UpdateResourceShare (updated)

Link ¶
Changes (response)

{'resourceShare': {'resourceShareConfiguration': {'retainSharingOnAccountLeaveOrganization': 'boolean'}}}

Modifies some of the properties of the specified resource share.

See also: AWS API Documentation

Request Syntax

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

type resourceShareArn:

string

param resourceShareArn:

[REQUIRED]

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

type name:

string

param name:

If specified, the new name that you want to attach to the resource share.

type allowExternalPrincipals:

boolean

param allowExternalPrincipals:

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

type clientToken:

string

param clientToken:

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.

rtype:

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',
        'resourceShareConfiguration': {
            'retainSharingOnAccountLeaveOrganization': True|False
        }
    },
    '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 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.
    - True – the resource share can be shared with any Amazon Web Services account.
    - False – the resource share can be shared with only accounts in the same organization as the account that owns the 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 what features are available for this resource share. This parameter can have one of the following values:
    - STANDARD – A resource share that supports all functionality. 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. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    - CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. 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 – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
  - resourceShareConfiguration (dict) --
    
    The configuration of the resource share
    - retainSharingOnAccountLeaveOrganization (boolean) --
      
      Specifies whether the consumer account retains access to the resource share after leaving the organization.
- 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.