Schemas 2019-12-02
- Client: Aws\Schemas\SchemasClient
- Service ID: schemas
- Version: 2019-12-02
This page describes the parameters and results for the operations of the Schemas (2019-12-02), and shows how to use the Aws\Schemas\SchemasClient object to call the described operations. This documentation is specific to the 2019-12-02 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateDiscoverer ( array $params = [] )
Creates a discoverer.
- CreateRegistry ( array $params = [] )
Creates a registry.
- CreateSchema ( array $params = [] )
Creates a schema definition.
- DeleteDiscoverer ( array $params = [] )
Deletes a discoverer.
- DeleteRegistry ( array $params = [] )
Deletes a Registry.
- DeleteResourcePolicy ( array $params = [] )
Delete the resource-based policy attached to the specified registry.
- DeleteSchema ( array $params = [] )
Delete a schema definition.
- DeleteSchemaVersion ( array $params = [] )
Delete the schema version definition
- DescribeCodeBinding ( array $params = [] )
Describe the code binding URI.
- DescribeDiscoverer ( array $params = [] )
Describes the discoverer.
- DescribeRegistry ( array $params = [] )
Describes the registry.
- DescribeSchema ( array $params = [] )
Retrieve the schema definition.
- ExportSchema ( array $params = [] )
Exports a schema to a different specification.
- GetCodeBindingSource ( array $params = [] )
Get the code binding source URI.
- GetDiscoveredSchema ( array $params = [] )
Get the discovered schema that was generated based on sampled events.
- GetResourcePolicy ( array $params = [] )
Retrieves the resource-based policy attached to a given registry.
- ListDiscoverers ( array $params = [] )
List the discoverers.
- ListRegistries ( array $params = [] )
List the registries.
- ListSchemaVersions ( array $params = [] )
Provides a list of the schema versions and related information.
- ListSchemas ( array $params = [] )
List the schemas.
- ListTagsForResource ( array $params = [] )
Get tags for resource.
- PutCodeBinding ( array $params = [] )
Put code binding URI
- PutResourcePolicy ( array $params = [] )
The name of the policy.
- SearchSchemas ( array $params = [] )
Search the schemas
- StartDiscoverer ( array $params = [] )
Starts the discoverer
- StopDiscoverer ( array $params = [] )
Stops the discoverer
- TagResource ( array $params = [] )
Add tags to a resource.
- UntagResource ( array $params = [] )
Removes tags from a resource.
- UpdateDiscoverer ( array $params = [] )
Updates the discoverer
- UpdateRegistry ( array $params = [] )
Updates a registry.
- UpdateSchema ( array $params = [] )
Updates the schema definition Inactive schemas will be deleted after two years.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
| Waiter name | API Operation | Delay | Max Attempts |
|---|---|---|---|
| CodeBindingExists | DescribeCodeBinding | 2 | 30 |
Operations
CreateDiscoverer
$result = $client->createDiscoverer([/* ... */]); $promise = $client->createDiscovererAsync([/* ... */]);
Creates a discoverer.
Parameter Syntax
$result = $client->createDiscoverer([
'CrossAccount' => true || false,
'Description' => '<string>',
'SourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- CrossAccount
-
- Type: boolean
- Description
-
- Type: string
- SourceArn
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Result Syntax
[
'CrossAccount' => true || false,
'Description' => '<string>',
'DiscovererArn' => '<string>',
'DiscovererId' => '<string>',
'SourceArn' => '<string>',
'State' => 'STARTED|STOPPED',
'Tags' => ['<string>', ...],
]
Result Details
Members
- CrossAccount
-
- Type: boolean
- Description
-
- Type: string
- DiscovererArn
-
- Type: string
- DiscovererId
-
- Type: string
- SourceArn
-
- Type: string
- State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
CreateRegistry
$result = $client->createRegistry([/* ... */]); $promise = $client->createRegistryAsync([/* ... */]);
Creates a registry.
Parameter Syntax
$result = $client->createRegistry([
'Description' => '<string>',
'RegistryName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Description
-
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Result Syntax
[
'Description' => '<string>',
'RegistryArn' => '<string>',
'RegistryName' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Description
-
- Type: string
- RegistryArn
-
- Type: string
- RegistryName
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
CreateSchema
$result = $client->createSchema([/* ... */]); $promise = $client->createSchemaAsync([/* ... */]);
Creates a schema definition.
Inactive schemas will be deleted after two years.
Parameter Syntax
$result = $client->createSchema([
'Content' => '<string>', // REQUIRED
'Description' => '<string>',
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
'Type' => 'OpenApi3', // REQUIRED
]);
Parameter Details
Members
- Content
-
- Required: Yes
- Type: string
- Description
-
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
- Type
-
- Required: Yes
- Type: string
Result Syntax
[
'Description' => '<string>',
'LastModified' => <DateTime>,
'SchemaArn' => '<string>',
'SchemaName' => '<string>',
'SchemaVersion' => '<string>',
'Tags' => ['<string>', ...],
'Type' => '<string>',
'VersionCreatedDate' => <DateTime>,
]
Result Details
Members
- Description
-
- Type: string
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SchemaArn
-
- Type: string
- SchemaName
-
- Type: string
- SchemaVersion
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
- Type
-
- Type: string
- VersionCreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
DeleteDiscoverer
$result = $client->deleteDiscoverer([/* ... */]); $promise = $client->deleteDiscovererAsync([/* ... */]);
Deletes a discoverer.
Parameter Syntax
$result = $client->deleteDiscoverer([
'DiscovererId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DiscovererId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
DeleteRegistry
$result = $client->deleteRegistry([/* ... */]); $promise = $client->deleteRegistryAsync([/* ... */]);
Deletes a Registry.
Parameter Syntax
$result = $client->deleteRegistry([
'RegistryName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- RegistryName
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
DeleteResourcePolicy
$result = $client->deleteResourcePolicy([/* ... */]); $promise = $client->deleteResourcePolicyAsync([/* ... */]);
Delete the resource-based policy attached to the specified registry.
Parameter Syntax
$result = $client->deleteResourcePolicy([
'RegistryName' => '<string>',
]);
Parameter Details
Members
- RegistryName
-
- Type: string
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
DeleteSchema
$result = $client->deleteSchema([/* ... */]); $promise = $client->deleteSchemaAsync([/* ... */]);
Delete a schema definition.
Parameter Syntax
$result = $client->deleteSchema([
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
DeleteSchemaVersion
$result = $client->deleteSchemaVersion([/* ... */]); $promise = $client->deleteSchemaVersionAsync([/* ... */]);
Delete the schema version definition
Parameter Syntax
$result = $client->deleteSchemaVersion([
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
'SchemaVersion' => '<string>', // REQUIRED
]);
Parameter Details
Members
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
- SchemaVersion
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
DescribeCodeBinding
$result = $client->describeCodeBinding([/* ... */]); $promise = $client->describeCodeBindingAsync([/* ... */]);
Describe the code binding URI.
Parameter Syntax
$result = $client->describeCodeBinding([
'Language' => '<string>', // REQUIRED
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
'SchemaVersion' => '<string>',
]);
Parameter Details
Members
- Language
-
- Required: Yes
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
- SchemaVersion
-
- Type: string
Result Syntax
[
'CreationDate' => <DateTime>,
'LastModified' => <DateTime>,
'SchemaVersion' => '<string>',
'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED',
]
Result Details
Members
- CreationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SchemaVersion
-
- Type: string
- Status
-
- Type: string
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
DescribeDiscoverer
$result = $client->describeDiscoverer([/* ... */]); $promise = $client->describeDiscovererAsync([/* ... */]);
Describes the discoverer.
Parameter Syntax
$result = $client->describeDiscoverer([
'DiscovererId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DiscovererId
-
- Required: Yes
- Type: string
Result Syntax
[
'CrossAccount' => true || false,
'Description' => '<string>',
'DiscovererArn' => '<string>',
'DiscovererId' => '<string>',
'SourceArn' => '<string>',
'State' => 'STARTED|STOPPED',
'Tags' => ['<string>', ...],
]
Result Details
Members
- CrossAccount
-
- Type: boolean
- Description
-
- Type: string
- DiscovererArn
-
- Type: string
- DiscovererId
-
- Type: string
- SourceArn
-
- Type: string
- State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
DescribeRegistry
$result = $client->describeRegistry([/* ... */]); $promise = $client->describeRegistryAsync([/* ... */]);
Describes the registry.
Parameter Syntax
$result = $client->describeRegistry([
'RegistryName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- RegistryName
-
- Required: Yes
- Type: string
Result Syntax
[
'Description' => '<string>',
'RegistryArn' => '<string>',
'RegistryName' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Description
-
- Type: string
- RegistryArn
-
- Type: string
- RegistryName
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
DescribeSchema
$result = $client->describeSchema([/* ... */]); $promise = $client->describeSchemaAsync([/* ... */]);
Retrieve the schema definition.
Parameter Syntax
$result = $client->describeSchema([
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
'SchemaVersion' => '<string>',
]);
Parameter Details
Members
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
- SchemaVersion
-
- Type: string
Result Syntax
[
'Content' => '<string>',
'Description' => '<string>',
'LastModified' => <DateTime>,
'SchemaArn' => '<string>',
'SchemaName' => '<string>',
'SchemaVersion' => '<string>',
'Tags' => ['<string>', ...],
'Type' => '<string>',
'VersionCreatedDate' => <DateTime>,
]
Result Details
Members
- Content
-
- Type: string
- Description
-
- Type: string
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SchemaArn
-
- Type: string
- SchemaName
-
- Type: string
- SchemaVersion
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
- Type
-
- Type: string
- VersionCreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
ExportSchema
$result = $client->exportSchema([/* ... */]); $promise = $client->exportSchemaAsync([/* ... */]);
Exports a schema to a different specification.
Parameter Syntax
$result = $client->exportSchema([
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
'SchemaVersion' => '<string>',
'Type' => '<string>', // REQUIRED
]);
Parameter Details
Members
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
- SchemaVersion
-
- Type: string
- Type
-
- Required: Yes
- Type: string
Result Syntax
[
'Content' => '<string>',
'SchemaArn' => '<string>',
'SchemaName' => '<string>',
'SchemaVersion' => '<string>',
'Type' => '<string>',
]
Result Details
Members
- Content
-
- Type: string
- SchemaArn
-
- Type: string
- SchemaName
-
- Type: string
- SchemaVersion
-
- Type: string
- Type
-
- Type: string
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
GetCodeBindingSource
$result = $client->getCodeBindingSource([/* ... */]); $promise = $client->getCodeBindingSourceAsync([/* ... */]);
Get the code binding source URI.
Parameter Syntax
$result = $client->getCodeBindingSource([
'Language' => '<string>', // REQUIRED
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
'SchemaVersion' => '<string>',
]);
Parameter Details
Members
- Language
-
- Required: Yes
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
- SchemaVersion
-
- Type: string
Result Syntax
[
'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
]
Result Details
Members
- Body
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
GetDiscoveredSchema
$result = $client->getDiscoveredSchema([/* ... */]); $promise = $client->getDiscoveredSchemaAsync([/* ... */]);
Get the discovered schema that was generated based on sampled events.
Parameter Syntax
$result = $client->getDiscoveredSchema([
'Events' => ['<string>', ...], // REQUIRED
'Type' => 'OpenApi3', // REQUIRED
]);
Parameter Details
Members
- Events
-
- Required: Yes
- Type: Array of strings
- Type
-
- Required: Yes
- Type: string
Result Syntax
[
'Content' => '<string>',
]
Result Details
Members
- Content
-
- Type: string
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
GetResourcePolicy
$result = $client->getResourcePolicy([/* ... */]); $promise = $client->getResourcePolicyAsync([/* ... */]);
Retrieves the resource-based policy attached to a given registry.
Parameter Syntax
$result = $client->getResourcePolicy([
'RegistryName' => '<string>',
]);
Parameter Details
Members
- RegistryName
-
- Type: string
Result Syntax
[
'Policy' => '<string>',
'RevisionId' => '<string>',
]
Result Details
Members
- Policy
-
- Type: string (string|number|array|map or anything parsable by json_encode)
- RevisionId
-
- Type: string
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
ListDiscoverers
$result = $client->listDiscoverers([/* ... */]); $promise = $client->listDiscoverersAsync([/* ... */]);
List the discoverers.
Parameter Syntax
$result = $client->listDiscoverers([
'DiscovererIdPrefix' => '<string>',
'Limit' => <integer>,
'NextToken' => '<string>',
'SourceArnPrefix' => '<string>',
]);
Parameter Details
Members
- DiscovererIdPrefix
-
- Type: string
- Limit
-
- Type: int
- NextToken
-
- Type: string
- SourceArnPrefix
-
- Type: string
Result Syntax
[
'Discoverers' => [
[
'CrossAccount' => true || false,
'DiscovererArn' => '<string>',
'DiscovererId' => '<string>',
'SourceArn' => '<string>',
'State' => 'STARTED|STOPPED',
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Discoverers
-
- Type: Array of DiscovererSummary structures
- NextToken
-
- Type: string
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
ListRegistries
$result = $client->listRegistries([/* ... */]); $promise = $client->listRegistriesAsync([/* ... */]);
List the registries.
Parameter Syntax
$result = $client->listRegistries([
'Limit' => <integer>,
'NextToken' => '<string>',
'RegistryNamePrefix' => '<string>',
'Scope' => '<string>',
]);
Parameter Details
Members
- Limit
-
- Type: int
- NextToken
-
- Type: string
- RegistryNamePrefix
-
- Type: string
- Scope
-
- Type: string
Result Syntax
[
'NextToken' => '<string>',
'Registries' => [
[
'RegistryArn' => '<string>',
'RegistryName' => '<string>',
'Tags' => ['<string>', ...],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Registries
-
- Type: Array of RegistrySummary structures
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
ListSchemaVersions
$result = $client->listSchemaVersions([/* ... */]); $promise = $client->listSchemaVersionsAsync([/* ... */]);
Provides a list of the schema versions and related information.
Parameter Syntax
$result = $client->listSchemaVersions([
'Limit' => <integer>,
'NextToken' => '<string>',
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Limit
-
- Type: int
- NextToken
-
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
Result Syntax
[
'NextToken' => '<string>',
'SchemaVersions' => [
[
'SchemaArn' => '<string>',
'SchemaName' => '<string>',
'SchemaVersion' => '<string>',
'Type' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- SchemaVersions
-
- Type: Array of SchemaVersionSummary structures
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
ListSchemas
$result = $client->listSchemas([/* ... */]); $promise = $client->listSchemasAsync([/* ... */]);
List the schemas.
Parameter Syntax
$result = $client->listSchemas([
'Limit' => <integer>,
'NextToken' => '<string>',
'RegistryName' => '<string>', // REQUIRED
'SchemaNamePrefix' => '<string>',
]);
Parameter Details
Members
- Limit
-
- Type: int
- NextToken
-
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
- SchemaNamePrefix
-
- Type: string
Result Syntax
[
'NextToken' => '<string>',
'Schemas' => [
[
'LastModified' => <DateTime>,
'SchemaArn' => '<string>',
'SchemaName' => '<string>',
'Tags' => ['<string>', ...],
'VersionCount' => <integer>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Schemas
-
- Type: Array of SchemaSummary structures
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Get tags for resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
PutCodeBinding
$result = $client->putCodeBinding([/* ... */]); $promise = $client->putCodeBindingAsync([/* ... */]);
Put code binding URI
Parameter Syntax
$result = $client->putCodeBinding([
'Language' => '<string>', // REQUIRED
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
'SchemaVersion' => '<string>',
]);
Parameter Details
Members
- Language
-
- Required: Yes
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
- SchemaVersion
-
- Type: string
Result Syntax
[
'CreationDate' => <DateTime>,
'LastModified' => <DateTime>,
'SchemaVersion' => '<string>',
'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED',
]
Result Details
Members
- CreationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SchemaVersion
-
- Type: string
- Status
-
- Type: string
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
PutResourcePolicy
$result = $client->putResourcePolicy([/* ... */]); $promise = $client->putResourcePolicyAsync([/* ... */]);
The name of the policy.
Parameter Syntax
$result = $client->putResourcePolicy([
'Policy' => '<string>', // REQUIRED
'RegistryName' => '<string>',
'RevisionId' => '<string>',
]);
Parameter Details
Members
- Policy
-
- Required: Yes
- Type: string (string|number|array|map or anything parsable by json_encode)
- RegistryName
-
- Type: string
- RevisionId
-
- Type: string
Result Syntax
[
'Policy' => '<string>',
'RevisionId' => '<string>',
]
Result Details
Members
- Policy
-
- Type: string (string|number|array|map or anything parsable by json_encode)
- RevisionId
-
- Type: string
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
SearchSchemas
$result = $client->searchSchemas([/* ... */]); $promise = $client->searchSchemasAsync([/* ... */]);
Search the schemas
Parameter Syntax
$result = $client->searchSchemas([
'Keywords' => '<string>', // REQUIRED
'Limit' => <integer>,
'NextToken' => '<string>',
'RegistryName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Keywords
-
- Required: Yes
- Type: string
- Limit
-
- Type: int
- NextToken
-
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
Result Syntax
[
'NextToken' => '<string>',
'Schemas' => [
[
'RegistryName' => '<string>',
'SchemaArn' => '<string>',
'SchemaName' => '<string>',
'SchemaVersions' => [
[
'CreatedDate' => <DateTime>,
'SchemaVersion' => '<string>',
'Type' => '<string>',
],
// ...
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Schemas
-
- Type: Array of SearchSchemaSummary structures
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
StartDiscoverer
$result = $client->startDiscoverer([/* ... */]); $promise = $client->startDiscovererAsync([/* ... */]);
Starts the discoverer
Parameter Syntax
$result = $client->startDiscoverer([
'DiscovererId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DiscovererId
-
- Required: Yes
- Type: string
Result Syntax
[
'DiscovererId' => '<string>',
'State' => 'STARTED|STOPPED',
]
Result Details
Members
- DiscovererId
-
- Type: string
- State
-
- Type: string
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
StopDiscoverer
$result = $client->stopDiscoverer([/* ... */]); $promise = $client->stopDiscovererAsync([/* ... */]);
Stops the discoverer
Parameter Syntax
$result = $client->stopDiscoverer([
'DiscovererId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DiscovererId
-
- Required: Yes
- Type: string
Result Syntax
[
'DiscovererId' => '<string>',
'State' => 'STARTED|STOPPED',
]
Result Details
Members
- DiscovererId
-
- Type: string
- State
-
- Type: string
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Add tags to a resource.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
- Tags
-
- Required: Yes
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from a resource.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
- TagKeys
-
- Required: Yes
- Type: Array of strings
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
UpdateDiscoverer
$result = $client->updateDiscoverer([/* ... */]); $promise = $client->updateDiscovererAsync([/* ... */]);
Updates the discoverer
Parameter Syntax
$result = $client->updateDiscoverer([
'CrossAccount' => true || false,
'Description' => '<string>',
'DiscovererId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- CrossAccount
-
- Type: boolean
- Description
-
- Type: string
- DiscovererId
-
- Required: Yes
- Type: string
Result Syntax
[
'CrossAccount' => true || false,
'Description' => '<string>',
'DiscovererArn' => '<string>',
'DiscovererId' => '<string>',
'SourceArn' => '<string>',
'State' => 'STARTED|STOPPED',
'Tags' => ['<string>', ...],
]
Result Details
Members
- CrossAccount
-
- Type: boolean
- Description
-
- Type: string
- DiscovererArn
-
- Type: string
- DiscovererId
-
- Type: string
- SourceArn
-
- Type: string
- State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
UpdateRegistry
$result = $client->updateRegistry([/* ... */]); $promise = $client->updateRegistryAsync([/* ... */]);
Updates a registry.
Parameter Syntax
$result = $client->updateRegistry([
'Description' => '<string>',
'RegistryName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Description
-
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
Result Syntax
[
'Description' => '<string>',
'RegistryArn' => '<string>',
'RegistryName' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Description
-
- Type: string
- RegistryArn
-
- Type: string
- RegistryName
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
UpdateSchema
$result = $client->updateSchema([/* ... */]); $promise = $client->updateSchemaAsync([/* ... */]);
Updates the schema definition
Inactive schemas will be deleted after two years.
Parameter Syntax
$result = $client->updateSchema([
'ClientTokenId' => '<string>',
'Content' => '<string>',
'Description' => '<string>',
'RegistryName' => '<string>', // REQUIRED
'SchemaName' => '<string>', // REQUIRED
'Type' => 'OpenApi3',
]);
Parameter Details
Members
- ClientTokenId
-
- Type: string
- Content
-
- Type: string
- Description
-
- Type: string
- RegistryName
-
- Required: Yes
- Type: string
- SchemaName
-
- Required: Yes
- Type: string
- Type
-
- Type: string
Result Syntax
[
'Description' => '<string>',
'LastModified' => <DateTime>,
'SchemaArn' => '<string>',
'SchemaName' => '<string>',
'SchemaVersion' => '<string>',
'Tags' => ['<string>', ...],
'Type' => '<string>',
'VersionCreatedDate' => <DateTime>,
]
Result Details
Members
- Description
-
- Type: string
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SchemaArn
-
- Type: string
- SchemaName
-
- Type: string
- SchemaVersion
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
- Type
-
- Type: string
- VersionCreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Errors
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
-
This error does not currently have a description.
Shapes
BadRequestException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
CodeBindingOutput
Members
- CreationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time and date that the code binding was created.
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that code bindings were modified.
- SchemaVersion
-
- Type: string
The version number of the schema.
- Status
-
- Type: string
The current status of code binding generation.
ConflictException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
CreateDiscovererInput
Members
- CrossAccount
-
- Type: boolean
Support discovery of schemas in events sent to the bus from another account. (default: true)
- Description
-
- Type: string
A description for the discoverer.
- SourceArn
-
- Required: Yes
- Type: string
The ARN of the event bus.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags associated with the resource.
CreateRegistryInput
Members
- Description
-
- Type: string
A description of the registry to be created.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags to associate with the registry.
CreateSchemaInput
Members
- Content
-
- Required: Yes
- Type: string
The source of the schema definition.
- Description
-
- Type: string
A description of the schema.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags associated with the schema.
- Type
-
- Required: Yes
- Type: string
The type of schema.
DescribeSchemaOutput
Members
- Content
-
- Type: string
The source of the schema definition.
- Description
-
- Type: string
The description of the schema.
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that schema was modified.
- SchemaArn
-
- Type: string
The ARN of the schema.
- SchemaName
-
- Type: string
The name of the schema.
- SchemaVersion
-
- Type: string
The version number of the schema
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags associated with the resource.
- Type
-
- Type: string
The type of the schema.
- VersionCreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the schema version was created.
DiscovererOutput
Members
- CrossAccount
-
- Type: boolean
The Status if the discoverer will discover schemas from events sent from another account.
- Description
-
- Type: string
The description of the discoverer.
- DiscovererArn
-
- Type: string
The ARN of the discoverer.
- DiscovererId
-
- Type: string
The ID of the discoverer.
- SourceArn
-
- Type: string
The ARN of the event bus.
- State
-
- Type: string
The state of the discoverer.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags associated with the resource.
DiscovererStateOutput
Members
- DiscovererId
-
- Type: string
The ID of the discoverer.
- State
-
- Type: string
The state of the discoverer.
DiscovererSummary
Members
- CrossAccount
-
- Type: boolean
The Status if the discoverer will discover schemas from events sent from another account.
- DiscovererArn
-
- Type: string
The ARN of the discoverer.
- DiscovererId
-
- Type: string
The ID of the discoverer.
- SourceArn
-
- Type: string
The ARN of the event bus.
- State
-
- Type: string
The state of the discoverer.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags associated with the resource.
ErrorOutput
Members
- Code
-
- Required: Yes
- Type: string
The error code.
- Message
-
- Required: Yes
- Type: string
The message string of the error output.
ExportSchemaOutput
Members
- Content
-
- Type: string
The content of the schema.
- SchemaArn
-
- Type: string
The ARN of the schema to export.
- SchemaName
-
- Type: string
The name of the schema to export.
- SchemaVersion
-
- Type: string
The version of the schema to export.
- Type
-
- Type: string
The type of schema to export.
ForbiddenException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
GetDiscoveredSchemaInput
Members
- Events
-
- Required: Yes
- Type: Array of strings
An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.
- Type
-
- Required: Yes
- Type: string
The type of event.
GetDiscoveredSchemaOutput
Description
Members
- Content
-
- Type: string
The source of the schema definition.
GetResourcePolicyOutput
Description
Information about the policy.
Members
- Policy
-
- Type: string (string|number|array|map or anything parsable by json_encode)
The resource-based policy.
- RevisionId
-
- Type: string
The revision ID.
GoneException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
InternalServerErrorException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
ListDiscoverersOutput
Members
- Discoverers
-
- Type: Array of DiscovererSummary structures
- NextToken
-
- Type: string
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.
ListRegistriesOutput
Description
List the registries.
Members
- NextToken
-
- Type: string
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
-
- Type: Array of RegistrySummary structures
An array of registry summaries.
ListSchemaVersionsOutput
Members
- NextToken
-
- Type: string
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.
- SchemaVersions
-
- Type: Array of SchemaVersionSummary structures
An array of schema version summaries.
ListSchemasOutput
Members
- NextToken
-
- Type: string
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.
- Schemas
-
- Type: Array of SchemaSummary structures
An array of schema summaries.
ListTagsForResourceOutput
Members
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
NotFoundException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
PreconditionFailedException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
PutResourcePolicyInput
Description
Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
Members
- Policy
-
- Required: Yes
- Type: string (string|number|array|map or anything parsable by json_encode)
The resource-based policy.
- RevisionId
-
- Type: string
The revision ID of the policy.
PutResourcePolicyOutput
Description
The resource-based policy.
Members
- Policy
-
- Type: string (string|number|array|map or anything parsable by json_encode)
The resource-based policy.
- RevisionId
-
- Type: string
The revision ID of the policy.
RegistryOutput
Members
- Description
-
- Type: string
The description of the registry.
- RegistryArn
-
- Type: string
The ARN of the registry.
- RegistryName
-
- Type: string
The name of the registry.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags associated with the registry.
RegistrySummary
Members
- RegistryArn
-
- Type: string
The ARN of the registry.
- RegistryName
-
- Type: string
The name of the registry.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags associated with the registry.
SchemaOutput
Members
- Description
-
- Type: string
The description of the schema.
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that schema was modified.
- SchemaArn
-
- Type: string
The ARN of the schema.
- SchemaName
-
- Type: string
The name of the schema.
- SchemaVersion
-
- Type: string
The version number of the schema
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Key-value pairs associated with a resource.
- Type
-
- Type: string
The type of the schema.
- VersionCreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the schema version was created.
SchemaSummary
Description
A summary of schema details.
Members
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that schema was modified.
- SchemaArn
-
- Type: string
The ARN of the schema.
- SchemaName
-
- Type: string
The name of the schema.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags associated with the schema.
- VersionCount
-
- Type: long (int|float)
The number of versions available for the schema.
SchemaVersionSummary
Members
- SchemaArn
-
- Type: string
The ARN of the schema version.
- SchemaName
-
- Type: string
The name of the schema.
- SchemaVersion
-
- Type: string
The version number of the schema.
- Type
-
- Type: string
SearchSchemaSummary
Members
- RegistryName
-
- Type: string
The name of the registry.
- SchemaArn
-
- Type: string
The ARN of the schema.
- SchemaName
-
- Type: string
The name of the schema.
- SchemaVersions
-
- Type: Array of SearchSchemaVersionSummary structures
An array of schema version summaries.
SearchSchemaVersionSummary
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the schema version was created.
- SchemaVersion
-
- Type: string
The version number of the schema
- Type
-
- Type: string
SearchSchemasOutput
Members
- NextToken
-
- Type: string
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.
- Schemas
-
- Type: Array of SearchSchemaSummary structures
An array of SearchSchemaSummary information.
ServiceUnavailableException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
TagResourceInput
Members
- Tags
-
- Required: Yes
- Type: Associative array of custom strings keys (__string) to strings
Tags associated with the resource.
TooManyRequestsException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
UnauthorizedException
Members
- Code
-
- Required: Yes
- Type: string
- Message
-
- Required: Yes
- Type: string
UpdateDiscovererInput
Members
- CrossAccount
-
- Type: boolean
Support discovery of schemas in events sent to the bus from another account. (default: true)
- Description
-
- Type: string
The description of the discoverer to update.
UpdateRegistryInput
Members
- Description
-
- Type: string
The description of the registry to update.
UpdateSchemaInput
Members
- ClientTokenId
-
- Type: string
The ID of the client token.
- Content
-
- Type: string
The source of the schema definition.
- Description
-
- Type: string
The description of the schema.
- Type
-
- Type: string
The schema type for the events schema.