Skip to content

ListComponentsInput

Source code in docs_src/capo_proton/types/list_components_input.py
class ListComponentsInput(TypedDict, closed=True):
    next_token: NotRequired["capo_proton.types.next_token.NextToken"]
    """<p>A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.</p>"""
    environment_name: NotRequired["capo_proton.types.resource_name.ResourceName"]
    """<p>The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.</p>"""
    service_name: NotRequired["capo_proton.types.resource_name.ResourceName"]
    """<p>The name of a service for result list filtering. Proton returns components attached to service instances of the service.</p>"""
    service_instance_name: NotRequired["capo_proton.types.resource_name.ResourceName"]
    """<p>The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.</p>"""
    max_results: NotRequired["capo_proton.types.max_page_results.MaxPageResults"]
    """<p>The maximum number of components to list.</p>"""

environment_name instance-attribute

environment_name: NotRequired[ResourceName]

The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

max_results instance-attribute

max_results: NotRequired[MaxPageResults]

The maximum number of components to list.

next_token instance-attribute

next_token: NotRequired[NextToken]

A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.

service_instance_name instance-attribute

service_instance_name: NotRequired[ResourceName]

The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

service_name instance-attribute

service_name: NotRequired[ResourceName]

The name of a service for result list filtering. Proton returns components attached to service instances of the service.