Skip to content

ListAppsRequest

Source code in docs_src/capo_resiliencehub/types/list_apps_request.py
class ListAppsRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_resiliencehub.types.next_token.NextToken"]
    """<p>Null, or the token from a previous call to get the next set of results.</p>"""
    max_results: NotRequired["capo_resiliencehub.types.max_results.MaxResults"]
    """<p>Maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"""
    name: NotRequired["capo_resiliencehub.types.entity_name.EntityName"]
    """<p>The name for the one of the listed applications.</p>"""
    app_arn: NotRequired["capo_resiliencehub.types.arn.Arn"]
    """<p>Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p>"""
    from_last_assessment_time: NotRequired[
        "capo_resiliencehub.types.time_stamp.TimeStamp"
    ]
    """<p>Lower limit of the range that is used to filter applications based on their last assessment times.</p>"""
    to_last_assessment_time: NotRequired[
        "capo_resiliencehub.types.time_stamp.TimeStamp"
    ]
    """<p>Upper limit of the range that is used to filter the applications based on their last assessment times.</p>"""
    reverse_order: NotRequired[
        "capo_resiliencehub.types.boolean_optional.BooleanOptional"
    ]
    """<p>The application list is sorted based on the values of <code>lastAppComplianceEvaluationTime</code> field. By default, application list is sorted in ascending order. To sort the application list in descending order, set this field to <code>True</code>.</p>"""
    aws_application_arn: NotRequired["capo_resiliencehub.types.arn.Arn"]
    """<p>Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p>"""

app_arn instance-attribute

app_arn: NotRequired[Arn]

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

aws_application_arn instance-attribute

aws_application_arn: NotRequired[Arn]

Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

from_last_assessment_time instance-attribute

from_last_assessment_time: NotRequired[TimeStamp]

Lower limit of the range that is used to filter applications based on their last assessment times.

max_results instance-attribute

max_results: NotRequired[MaxResults]

Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

name instance-attribute

name: NotRequired[EntityName]

The name for the one of the listed applications.

next_token instance-attribute

next_token: NotRequired[NextToken]

Null, or the token from a previous call to get the next set of results.

reverse_order instance-attribute

reverse_order: NotRequired[BooleanOptional]

The application list is sorted based on the values of lastAppComplianceEvaluationTime field. By default, application list is sorted in ascending order. To sort the application list in descending order, set this field to True.

to_last_assessment_time instance-attribute

to_last_assessment_time: NotRequired[TimeStamp]

Upper limit of the range that is used to filter the applications based on their last assessment times.