list_registries¶
Operation¶
async
¶
list_registries(input: ListRegistriesInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
ListRegistriesInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
ListRegistriesOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListRegistriesInput structure.
Attributes¶
class-attribute
instance-attribute
¶
authorizer_type: RegistryAuthorizerType | None = 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.
class-attribute
instance-attribute
¶
max_results: int | None = 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.
class-attribute
instance-attribute
¶
next_token: str | None = 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.
class-attribute
instance-attribute
¶
status: RegistryStatus | None = None
Filter registries by their current status. Possible values include
CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED,
DELETING, and DELETE_FAILED.
Output¶
dataclass
¶
Dataclass for ListRegistriesOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = 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.
instance-attribute
¶
registries: list[RegistrySummary]
The list of registry summaries. For details about the fields in each
summary, see the RegistrySummary data type.