Skip to content

list_registries

Operation

list_registries

list_registries(request: ListRegistriesInput | ListRegistriesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRegistriesInputDict]) -> ListRegistriesOutput

Lists all registries in the account. You can optionally filter results by status using the status parameter, or by authorizer type using the authorizerType parameter.

Parameters:

Name Type Description Default
request ListRegistriesInput | ListRegistriesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListRegistriesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListRegistriesOutput

An instance of ListRegistriesOutput.

list_registries async

list_registries(request: ListRegistriesInput | ListRegistriesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRegistriesInputDict]) -> ListRegistriesOutput

Lists all registries in the account. You can optionally filter results by status using the status parameter, or by authorizer type using the authorizerType parameter.

Parameters:

Name Type Description Default
request ListRegistriesInput | ListRegistriesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListRegistriesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListRegistriesOutput

An instance of ListRegistriesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListRegistriesInputDict

Bases: TypedDict

Dictionary form of ListRegistriesInput.

Attributes

authorizer_type instance-attribute
authorizer_type: str | None

Filter registries by their authorizer type. Possible values are CUSTOM_JWT and AWS_IAM. For more information about authorizer types, see the RegistryAuthorizerType enum.

max_results instance-attribute
max_results: int | None

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

next_token instance-attribute
next_token: str | None

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

status instance-attribute
status: str | None

Filter registries by their current status. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

ListRegistriesInput dataclass

Bases: _SerdeShape

Dataclass for ListRegistriesInput structure.

Attributes

authorizer_type class-attribute instance-attribute
authorizer_type: str | None = ...

Filter registries by their authorizer type. Possible values are CUSTOM_JWT and AWS_IAM. For more information about authorizer types, see the RegistryAuthorizerType enum.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

next_token class-attribute instance-attribute
next_token: str | None = ...

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

status class-attribute instance-attribute
status: str | None = ...

Filter registries by their current status. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

Output

ListRegistriesOutput dataclass

Bases: _SerdeShape

Dataclass for ListRegistriesOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

registries instance-attribute
registries: list[RegistrySummary]

The list of registry summaries. For details about the fields in each summary, see the RegistrySummary data type.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.