Skip to content

ListResourcesRequest

Source code in docs_src/capo_ram/types/list_resources_request.py
class ListResourcesRequest(TypedDict, closed=True):
    resource_owner: "capo_ram.types.resource_owner.ResourceOwner"
    """<p>Specifies that you want to list only the resource shares that match the following:</p> <ul> <li> <p> <b> <code>SELF</code> </b> – resources that your account shares with other accounts</p> </li> <li> <p> <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts share with your account</p> </li> </ul>"""
    principal: NotRequired["capo_ram.types.string.String"]
    """<p>Specifies that you want to list only the resource shares that are associated with the specified principal.</p>"""
    resource_type: NotRequired["capo_ram.types.string.String"]
    """<p>Specifies that you want to list only the resource shares that include resources of the specified resource type.</p> <p>For valid values, query the <a>ListResourceTypes</a> operation.</p>"""
    resource_arns: NotRequired["capo_ram.types.resource_arn_list.ResourceArnList"]
    """<p>Specifies that you want to list only the resource shares that include resources with the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>"""
    resource_share_arns: NotRequired[
        "capo_ram.types.resource_share_arn_list.ResourceShareArnList"
    ]
    """<p>Specifies that you want to list only resources in the resource shares identified by the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>"""
    next_token: NotRequired["capo_ram.types.string.String"]
    """<p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> 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 <code>NextToken</code> response to request the next page of results.</p>"""
    max_results: NotRequired["capo_ram.types.max_results.MaxResults"]
    """<p>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 <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> 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 <code>NextToken</code> after every operation to ensure that you receive all of the results.</p>"""
    resource_region_scope: NotRequired[
        "capo_ram.types.resource_region_scope_filter.ResourceRegionScopeFilter"
    ]
    """<p>Specifies that you want the results to include only resources that have the specified scope.</p> <ul> <li> <p> <code>ALL</code> – the results include both global and regional resources or resource types.</p> </li> <li> <p> <code>GLOBAL</code> – the results include only global resources or resource types.</p> </li> <li> <p> <code>REGIONAL</code> – the results include only regional resources or resource types.</p> </li> </ul> <p>The default value is <code>ALL</code>.</p>"""

max_results instance-attribute

max_results: NotRequired[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.

next_token instance-attribute

next_token: NotRequired[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.

principal instance-attribute

principal: NotRequired[String]

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

resource_arns instance-attribute

resource_arns: NotRequired[ResourceArnList]

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

resource_owner instance-attribute

resource_owner: ResourceOwner

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

resource_region_scope instance-attribute

resource_region_scope: NotRequired[ResourceRegionScopeFilter]

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.

resource_share_arns instance-attribute

resource_share_arns: NotRequired[ResourceShareArnList]

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

resource_type instance-attribute

resource_type: NotRequired[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.