Skip to content

ListEngagementsRequest

Source code in docs_src/capo_partnercentral_selling/types/list_engagements_request.py
class ListEngagementsRequest(TypedDict, closed=True):
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier"
    """<p> Specifies the catalog related to the request. </p>"""
    created_by: NotRequired[
        "capo_partnercentral_selling.types.aws_account_list.AwsAccountList"
    ]
    """<p> A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members. </p>"""
    exclude_created_by: NotRequired[
        "capo_partnercentral_selling.types.aws_account_list.AwsAccountList"
    ]
    """<p>An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users. </p>"""
    context_types: NotRequired[
        "capo_partnercentral_selling.types.engagement_context_type_list.EngagementContextTypeList"
    ]
    """<p>Filters engagements to include only those containing the specified context types, such as "CustomerProject" or "Lead". Use this to find engagements that have specific types of contextual information associated with them.</p>"""
    exclude_context_types: NotRequired[
        "capo_partnercentral_selling.types.engagement_context_type_list.EngagementContextTypeList"
    ]
    """<p>Filters engagements to exclude those containing the specified context types. Use this to find engagements that do not have certain types of contextual information, helping to narrow results based on context exclusion criteria.</p>"""
    sort: NotRequired[
        "capo_partnercentral_selling.types.engagement_sort.EngagementSort"
    ]
    max_results: (
        "capo_partnercentral_selling.types.engagement_page_size.EngagementPageSize"
    )
    """<p>The maximum number of results to return in a single call.</p>"""
    next_token: NotRequired["str"]
    """<p>The token for the next set of results. This value is returned from a previous call.</p>"""
    engagement_identifier: NotRequired[
        "capo_partnercentral_selling.types.engagement_identifiers.EngagementIdentifiers"
    ]
    """<p>An array of strings representing engagement identifiers to retrieve.</p>"""

catalog instance-attribute

Specifies the catalog related to the request.

context_types instance-attribute

context_types: NotRequired[EngagementContextTypeList]

Filters engagements to include only those containing the specified context types, such as "CustomerProject" or "Lead". Use this to find engagements that have specific types of contextual information associated with them.

created_by instance-attribute

created_by: NotRequired[AwsAccountList]

A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

engagement_identifier instance-attribute

engagement_identifier: NotRequired[EngagementIdentifiers]

An array of strings representing engagement identifiers to retrieve.

exclude_context_types instance-attribute

exclude_context_types: NotRequired[EngagementContextTypeList]

Filters engagements to exclude those containing the specified context types. Use this to find engagements that do not have certain types of contextual information, helping to narrow results based on context exclusion criteria.

exclude_created_by instance-attribute

exclude_created_by: NotRequired[AwsAccountList]

An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

max_results instance-attribute

max_results: EngagementPageSize

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

next_token instance-attribute

next_token: NotRequired[str]

The token for the next set of results. This value is returned from a previous call.

sort instance-attribute

sort: NotRequired[EngagementSort]