Skip to content

ListAssociationsRequest

Source code in docs_src/capo_sagemaker/types/list_associations_request.py
class ListAssociationsRequest(TypedDict, closed=True):
    source_arn: NotRequired[
        "capo_sagemaker.types.association_entity_arn.AssociationEntityArn"
    ]
    """<p>A filter that returns only associations with the specified source ARN.</p>"""
    destination_arn: NotRequired[
        "capo_sagemaker.types.association_entity_arn.AssociationEntityArn"
    ]
    """<p>A filter that returns only associations with the specified destination Amazon Resource Name (ARN).</p>"""
    source_type: NotRequired["capo_sagemaker.types.string256.String256"]
    """<p>A filter that returns only associations with the specified source type.</p>"""
    destination_type: NotRequired["capo_sagemaker.types.string256.String256"]
    """<p>A filter that returns only associations with the specified destination type.</p>"""
    association_type: NotRequired[
        "capo_sagemaker.types.association_edge_type.AssociationEdgeType"
    ]
    """<p>A filter that returns only associations of the specified type.</p>"""
    created_after: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns only associations created on or after the specified time.</p>"""
    created_before: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns only associations created on or before the specified time.</p>"""
    sort_by: NotRequired["capo_sagemaker.types.sort_associations_by.SortAssociationsBy"]
    """<p>The property used to sort results. The default value is <code>CreationTime</code>.</p>"""
    sort_order: NotRequired["capo_sagemaker.types.sort_order.SortOrder"]
    """<p>The sort order. The default value is <code>Descending</code>.</p>"""
    next_token: NotRequired["capo_sagemaker.types.next_token.NextToken"]
    """<p>If the previous call to <code>ListAssociations</code> didn't return the full set of associations, the call returns a token for getting the next set of associations.</p>"""
    max_results: NotRequired["capo_sagemaker.types.max_results.MaxResults"]
    """<p>The maximum number of associations to return in the response. The default value is 10.</p>"""

association_type instance-attribute

association_type: NotRequired[AssociationEdgeType]

A filter that returns only associations of the specified type.

created_after instance-attribute

created_after: NotRequired[Timestamp]

A filter that returns only associations created on or after the specified time.

created_before instance-attribute

created_before: NotRequired[Timestamp]

A filter that returns only associations created on or before the specified time.

destination_arn instance-attribute

destination_arn: NotRequired[AssociationEntityArn]

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

destination_type instance-attribute

destination_type: NotRequired[String256]

A filter that returns only associations with the specified destination type.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of associations to return in the response. The default value is 10.

next_token instance-attribute

next_token: NotRequired[NextToken]

If the previous call to ListAssociations didn't return the full set of associations, the call returns a token for getting the next set of associations.

sort_by instance-attribute

sort_by: NotRequired[SortAssociationsBy]

The property used to sort results. The default value is CreationTime.

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

The sort order. The default value is Descending.

source_arn instance-attribute

source_arn: NotRequired[AssociationEntityArn]

A filter that returns only associations with the specified source ARN.

source_type instance-attribute

source_type: NotRequired[String256]

A filter that returns only associations with the specified source type.