AWS Resource Access Manager

2021/12/02 - AWS Resource Access Manager - 3 updated api methods

Changes  This release adds the ability to use the new ResourceRegionScope parameter on List operations that return lists of resources or resource types. This new parameter filters the results by letting you differentiate between global or regional resource types.

ListPendingInvitationResources (updated) Link ¶
Changes (request, response)
Request 
{'resourceRegionScope': 'ALL | REGIONAL | GLOBAL'}
Response 
{'resources': {'resourceRegionScope': 'REGIONAL | GLOBAL'}}

Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING . That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.

See also: AWS API Documentation

Request Syntax

client.list_pending_invitation_resources(
    resourceShareInvitationArn='string',
    nextToken='string',
    maxResults=123,
    resourceRegionScope='ALL'|'REGIONAL'|'GLOBAL'
)
type resourceShareInvitationArn

string

param resourceShareInvitationArn

[REQUIRED]

Specifies the Amazon Resoure Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.

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 resourceRegionScope

string

param resourceRegionScope

Specifies that you want the results to include only resources that have the specified scope.

  • ALL – the results include both global and regional resources or resource types.

  • GLOBAL – the results include only global resources or resource types.

  • REGIONAL – the results include only regional resources or resource types.

The default value is ALL .

rtype

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),
            'resourceRegionScope': 'REGIONAL'|'GLOBAL'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • resources (list) --

      An array of objects that contain the information about the resources included the specified resource share.

      • (dict) --

        Describes a resource associated with a resource share in RAM.

        • arn (string) --

          The Amazon Resoure Name (ARN) of the resource.

        • type (string) --

          The resource type. This takes the form of: service-code :resource-code

        • resourceShareArn (string) --

          The Amazon Resoure Name (ARN) of the resource share this resource is associated with.

        • resourceGroupArn (string) --

          The Amazon Resoure Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.

        • status (string) --

          The current status of the resource.

        • statusMessage (string) --

          A message about the status of the resource.

        • creationTime (datetime) --

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

        • lastUpdatedTime (datetime) --

          The date an time when the association was last updated.

        • resourceRegionScope (string) --

          Specifies the scope of visibility of this resource:

          • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

          • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

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

ListResourceTypes (updated) Link ¶
Changes (request, response)
Request 
{'resourceRegionScope': 'ALL | REGIONAL | GLOBAL'}
Response 
{'resourceTypes': {'resourceRegionScope': 'REGIONAL | GLOBAL'}}

Lists the resource types that can be shared by RAM.

See also: AWS API Documentation

Request Syntax

client.list_resource_types(
    nextToken='string',
    maxResults=123,
    resourceRegionScope='ALL'|'REGIONAL'|'GLOBAL'
)
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 resourceRegionScope

string

param resourceRegionScope

Specifies that you want the results to include only resources that have the specified scope.

  • ALL – the results include both global and regional resources or resource types.

  • GLOBAL – the results include only global resources or resource types.

  • REGIONAL – the results include only regional resources or resource types.

The default value is ALL .

rtype

dict

returns

Response Syntax

{
    'resourceTypes': [
        {
            'resourceType': 'string',
            'serviceName': 'string',
            'resourceRegionScope': 'REGIONAL'|'GLOBAL'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • resourceTypes (list) --

      An array of objects that contain information about the resource types that can be shared using RAM.

      • (dict) --

        Information about a shareable resource type and the Amazon Web Services service to which resources of that type belong.

        • resourceType (string) --

          The type of the resource.

        • serviceName (string) --

          The name of the Amazon Web Services service to which resources of this type belong.

        • resourceRegionScope (string) --

          Specifies the scope of visibility of resources of this type:

          • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

          • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

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

ListResources (updated) Link ¶
Changes (request, response)
Request 
{'resourceRegionScope': 'ALL | REGIONAL | GLOBAL'}
Response 
{'resources': {'resourceRegionScope': 'REGIONAL | GLOBAL'}}

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

client.list_resources(
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    principal='string',
    resourceType='string',
    resourceArns=[
        'string',
    ],
    resourceShareArns=[
        'string',
    ],
    nextToken='string',
    maxResults=123,
    resourceRegionScope='ALL'|'REGIONAL'|'GLOBAL'
)
type resourceOwner

string

param resourceOwner

[REQUIRED]

Specifies that you want to list only the resource shares that match the following:

  • **SELF ** – resources that you are sharing

  • **OTHER-ACCOUNTS ** – resources that other accounts share with you

type principal

string

param principal

Specifies that you want to list only the resource shares that are associated with the specified principal.

type resourceType

string

param resourceType

Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

type resourceArns

list

param resourceArns

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs) .

  • (string) --

type resourceShareArns

list

param resourceShareArns

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs) .

  • (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 resourceRegionScope

string

param resourceRegionScope

Specifies that you want the results to include only resources that have the specified scope.

  • ALL – the results include both global and regional resources or resource types.

  • GLOBAL – the results include only global resources or resource types.

  • REGIONAL – the results include only regional resources or resource types.

The default value is ALL .

rtype

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),
            'resourceRegionScope': 'REGIONAL'|'GLOBAL'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • resources (list) --

      An array of objects that contain information about the resources.

      • (dict) --

        Describes a resource associated with a resource share in RAM.

        • arn (string) --

          The Amazon Resoure Name (ARN) of the resource.

        • type (string) --

          The resource type. This takes the form of: service-code :resource-code

        • resourceShareArn (string) --

          The Amazon Resoure Name (ARN) of the resource share this resource is associated with.

        • resourceGroupArn (string) --

          The Amazon Resoure Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.

        • status (string) --

          The current status of the resource.

        • statusMessage (string) --

          A message about the status of the resource.

        • creationTime (datetime) --

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

        • lastUpdatedTime (datetime) --

          The date an time when the association was last updated.

        • resourceRegionScope (string) --

          Specifies the scope of visibility of this resource:

          • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

          • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

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