RAM / Client / list_resources

list_resources#

RAM.Client.list_resources(**kwargs)#

Lists the resources that you added to a resource share 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,
    resourceRegionScope='ALL'|'REGIONAL'|'GLOBAL'
)
Parameters:

  • resourceOwner (string) –

    [REQUIRED]

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

    • SELF – resources that your account shares with other accounts

    • OTHER-ACCOUNTS – resources that other accounts share with your account

  • principal (string) – Specifies that you want to list only the resource shares that are associated with the specified principal.

  • resourceType (string) –

    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.

  • resourceArns (list) –

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

    • (string) –

  • resourceShareArns (list) –

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

    • (string) –

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

  • maxResults (integer) – 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.

  • resourceRegionScope (string) –

    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.

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),
            '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.

Exceptions

  • RAM.Client.exceptions.InvalidResourceTypeException

  • RAM.Client.exceptions.UnknownResourceException

  • RAM.Client.exceptions.MalformedArnException

  • RAM.Client.exceptions.InvalidNextTokenException

  • RAM.Client.exceptions.InvalidParameterException

  • RAM.Client.exceptions.ServerInternalException

  • RAM.Client.exceptions.ServiceUnavailableException