Skip to content

GetResourceShareAssociationsRequest

Source code in docs_src/capo_ram/types/get_resource_share_associations_request.py
class GetResourceShareAssociationsRequest(TypedDict, closed=True):
    association_type: (
        "capo_ram.types.resource_share_association_type.ResourceShareAssociationType"
    )
    """<p>Specifies whether you want to retrieve the associations that involve a specified resource or principal.</p> <ul> <li> <p> <code>PRINCIPAL</code> – list the principals whose associations you want to see.</p> </li> <li> <p> <code>RESOURCE</code> – list the resources whose associations you want to see.</p> </li> </ul>"""
    resource_share_arns: NotRequired[
        "capo_ram.types.resource_share_arn_list.ResourceShareArnList"
    ]
    """<p>Specifies a list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resource share whose associations you want to retrieve.</p>"""
    resource_arn: NotRequired["capo_ram.types.string.String"]
    """<p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of a resource whose resource shares you want to retrieve.</p> <p>You cannot specify this parameter if the association type is <code>PRINCIPAL</code>.</p>"""
    principal: NotRequired["capo_ram.types.string.String"]
    """<p>Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an individual IAM role or user.</p> <p>You cannot specify this parameter if the association type is <code>RESOURCE</code>.</p>"""
    association_status: NotRequired[
        "capo_ram.types.resource_share_association_status.ResourceShareAssociationStatus"
    ]
    """<p>Specifies that you want to retrieve only associations that have this status.</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>"""

association_status instance-attribute

association_status: NotRequired[ResourceShareAssociationStatus]

Specifies that you want to retrieve only associations that have this status.

association_type instance-attribute

association_type: ResourceShareAssociationType

Specifies whether you want to retrieve the associations that involve a specified resource or principal.

  • PRINCIPAL – list the principals whose associations you want to see.

  • RESOURCE – list the resources whose associations you want to see.

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 the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resource Name (ARN) of an individual IAM role or user.

You cannot specify this parameter if the association type is RESOURCE.

resource_arn instance-attribute

resource_arn: NotRequired[String]

Specifies the Amazon Resource Name (ARN) of a resource whose resource shares you want to retrieve.

You cannot specify this parameter if the association type is PRINCIPAL.

resource_share_arns instance-attribute

resource_share_arns: NotRequired[ResourceShareArnList]

Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.