Registries - Amazon EventBridge Schemas

Registries

URI

/v1/registries

HTTP methods

GET

Operation ID: ListRegistries

List the registries.

Query parameters
NameTypeRequiredDescription
scopeStringFalse

Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

limitStringFalse

The maximum number of results to return per page.

nextTokenStringFalse

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

registryNamePrefixStringFalse

Specifying this limits the results to only those registry names that start with the specified prefix.

Responses
Status codeResponse modelDescription
200ListRegistriesOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

500ErrorOutput

500 response

503ErrorOutput

503 response

OPTIONS

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Response bodies

{ "NextToken": "string", "Registries": [ { "RegistryName": "string", "RegistryArn": "string", "tags": { } } ] }
{ "Message": "string", "Code": "string" }

Properties

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.

ListRegistriesOutput

List the registries.

PropertyTypeRequiredDescription
NextToken

string

False

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

Registries

Array of type RegistrySummary

False

An array of registry summaries.

RegistrySummary

PropertyTypeRequiredDescription
RegistryArn

string

False

The ARN of the registry.

RegistryName

string

False

The name of the registry.

tags

Tags

False

Tags associated with the registry.

Tags

Key-value pairs associated with a resource.

PropertyTypeRequiredDescription

*

string

False