Skip to content

ListRelationshipsRequest

Source code in docs_src/capo_partnercentral_channel/types/list_relationships_request.py
class ListRelationshipsRequest(TypedDict, closed=True):
    catalog: "capo_partnercentral_channel.types.catalog.Catalog"
    """<p>The catalog identifier to filter relationships.</p>"""
    max_results: "int"
    """<p>The maximum number of results to return in a single call.</p>"""
    associated_account_ids: NotRequired[
        "capo_partnercentral_channel.types.account_id_list.AccountIdList"
    ]
    """<p>Filter by associated AWS account IDs.</p>"""
    association_types: NotRequired[
        "capo_partnercentral_channel.types.association_type_list.AssociationTypeList"
    ]
    """<p>Filter by association types.</p>"""
    display_names: NotRequired[
        "capo_partnercentral_channel.types.relationship_display_name_list.RelationshipDisplayNameList"
    ]
    """<p>Filter by display names.</p>"""
    program_management_account_identifiers: NotRequired[
        "capo_partnercentral_channel.types.program_management_account_identifier_list.ProgramManagementAccountIdentifierList"
    ]
    """<p>Filter by program management account identifiers.</p>"""
    sort: NotRequired[
        "capo_partnercentral_channel.types.list_relationships_sort_base.ListRelationshipsSortBase"
    ]
    """<p>Sorting options for the results.</p>"""
    next_token: NotRequired["capo_partnercentral_channel.types.next_token.NextToken"]
    """<p>Token for retrieving the next page of results.</p>"""

associated_account_ids instance-attribute

associated_account_ids: NotRequired[AccountIdList]

Filter by associated AWS account IDs.

association_types instance-attribute

association_types: NotRequired[AssociationTypeList]

Filter by association types.

catalog instance-attribute

catalog: Catalog

The catalog identifier to filter relationships.

display_names instance-attribute

display_names: NotRequired[RelationshipDisplayNameList]

Filter by display names.

max_results instance-attribute

max_results: int

The maximum number of results to return in a single call.

next_token instance-attribute

next_token: NotRequired[NextToken]

Token for retrieving the next page of results.

program_management_account_identifiers instance-attribute

program_management_account_identifiers: NotRequired[
    ProgramManagementAccountIdentifierList
]

Filter by program management account identifiers.

sort instance-attribute

sort: NotRequired[ListRelationshipsSortBase]

Sorting options for the results.