Skip to content

GetResourceSharesRequest

Source code in docs_src/capo_ram/types/get_resource_shares_request.py
class GetResourceSharesRequest(TypedDict, closed=True):
    resource_share_arns: NotRequired[
        "capo_ram.types.resource_share_arn_list.ResourceShareArnList"
    ]
    """<p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of individual resource shares that you want information about.</p>"""
    resource_share_status: NotRequired[
        "capo_ram.types.resource_share_status.ResourceShareStatus"
    ]
    """<p>Specifies that you want to retrieve details of only those resource shares that have this status.</p>"""
    resource_owner: "capo_ram.types.resource_owner.ResourceOwner"
    """<p>Specifies that you want to retrieve details of only those resource shares that match the following:</p> <ul> <li> <p> <b> <code>SELF</code> </b> – resource shares that your account shares with other accounts</p> </li> <li> <p> <b> <code>OTHER-ACCOUNTS</code> </b> – resource shares that other accounts share with your account</p> </li> </ul>"""
    name: NotRequired["capo_ram.types.string.String"]
    """<p>Specifies the name of an individual resource share that you want to retrieve details about.</p>"""
    tag_filters: NotRequired["capo_ram.types.tag_filters.TagFilters"]
    """<p>Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.</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>"""
    permission_arn: NotRequired["capo_ram.types.string.String"]
    """<p>Specifies that you want to retrieve details of only those resource shares that use the managed permission with this <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a>.</p>"""
    permission_version: NotRequired["capo_ram.types.integer.Integer"]
    """<p>Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.</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.

name instance-attribute

name: NotRequired[String]

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

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.

permission_arn instance-attribute

permission_arn: NotRequired[String]

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

permission_version instance-attribute

permission_version: NotRequired[Integer]

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

resource_owner instance-attribute

resource_owner: ResourceOwner

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

resource_share_arns instance-attribute

resource_share_arns: NotRequired[ResourceShareArnList]

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

resource_share_status instance-attribute

resource_share_status: NotRequired[ResourceShareStatus]

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

tag_filters instance-attribute

tag_filters: NotRequired[TagFilters]

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