Skip to content

list_registry_records

Operation

list_registry_records

list_registry_records(request: ListRegistryRecordsInput | ListRegistryRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRegistryRecordsInputDict]) -> ListRegistryRecordsOutput

Lists registry records within a registry. You can optionally filter results using the name, status, and descriptorType parameters. When multiple filters are specified, they are combined using AND logic.

Parameters:

Name Type Description Default
request ListRegistryRecordsInput | ListRegistryRecordsInputDict | 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[ListRegistryRecordsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListRegistryRecordsOutput

An instance of ListRegistryRecordsOutput.

list_registry_records async

list_registry_records(request: ListRegistryRecordsInput | ListRegistryRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRegistryRecordsInputDict]) -> ListRegistryRecordsOutput

Lists registry records within a registry. You can optionally filter results using the name, status, and descriptorType parameters. When multiple filters are specified, they are combined using AND logic.

Parameters:

Name Type Description Default
request ListRegistryRecordsInput | ListRegistryRecordsInputDict | 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[ListRegistryRecordsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListRegistryRecordsOutput

An instance of ListRegistryRecordsOutput.

Input

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

ListRegistryRecordsInputDict

Bases: TypedDict

Dictionary form of ListRegistryRecordsInput.

Attributes

descriptor_type instance-attribute
descriptor_type: str | None

Filter registry records by their descriptor type. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

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.

name instance-attribute
name: str | None

Filter registry records by name.

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.

registry_id instance-attribute
registry_id: Required[str]

The identifier of the registry to list records from. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

status instance-attribute
status: str | None

Filter registry records by their current status. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

ListRegistryRecordsInput dataclass

Bases: _SerdeShape

Dataclass for ListRegistryRecordsInput structure.

Attributes

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

Filter registry records by their descriptor type. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

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.

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

Filter registry records by name.

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.

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

The identifier of the registry to list records from. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

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

Filter registry records by their current status. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

Output

ListRegistryRecordsOutput dataclass

Bases: _SerdeShape

Dataclass for ListRegistryRecordsOutput 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.

registry_records instance-attribute
registry_records: list[RegistryRecordSummary]

The list of registry record summaries. For details about the fields in each summary, see the RegistryRecordSummary 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.