Skip to content

ListDeploymentsRequest

Source code in docs_src/capo_greengrassv2/types/list_deployments_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ListDeploymentsRequest(TypedDict, closed=True):
    target_arn: NotRequired["capo_greengrassv2.types.target_arn.TargetARN"]
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>"""
    history_filter: NotRequired[
        "capo_greengrassv2.types.deployment_history_filter.DeploymentHistoryFilter"
    ]
    """<p>The filter for the list of deployments. Choose one of the following options:</p> <ul> <li> <p> <code>ALL</code> – The list includes all deployments.</p> </li> <li> <p> <code>LATEST_ONLY</code> – The list includes only the latest revision of each deployment.</p> </li> </ul> <p>Default: <code>LATEST_ONLY</code> </p>"""
    parent_target_arn: NotRequired[
        "capo_greengrassv2.types.thing_group_arn.ThingGroupARN"
    ]
    """<p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>"""
    max_results: NotRequired[
        "capo_greengrassv2.types.default_max_results.DefaultMaxResults"
    ]
    """<p>The maximum number of results to be returned per paginated request.</p> <p>Default: <code>50</code> </p>"""
    next_token: NotRequired["capo_greengrassv2.types.next_token_string.NextTokenString"]
    """<p>The token to be used for the next set of paginated results.</p>"""

history_filter instance-attribute 

history_filter: NotRequired[DeploymentHistoryFilter]

The filter for the list of deployments. Choose one of the following options:

  • ALL – The list includes all deployments.

  • LATEST_ONLY – The list includes only the latest revision of each deployment.

Default: LATEST_ONLY

max_results instance-attribute 

max_results: NotRequired[DefaultMaxResults]

The maximum number of results to be returned per paginated request.

Default: 50

next_token instance-attribute 

next_token: NotRequired[NextTokenString]

The token to be used for the next set of paginated results.

parent_target_arn instance-attribute 

parent_target_arn: NotRequired[ThingGroupARN]

The parent deployment's target ARN within a subdeployment.

target_arn instance-attribute 

target_arn: NotRequired[TargetARN]

The ARN of the target IoT thing or thing group.