com.amazonaws.services.schemas

Interface AWSSchemas

All Known Subinterfaces:

AWSSchemasAsync

All Known Implementing Classes:

AbstractAWSSchemas, AbstractAWSSchemasAsync, AWSSchemasAsyncClient, AWSSchemasClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSchemas

Interface for accessing Schemas.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSchemas instead.

AWS EventBridge Schemas

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateDiscovererResult	createDiscoverer(CreateDiscovererRequest createDiscovererRequest) Creates a discoverer.
CreateRegistryResult	createRegistry(CreateRegistryRequest createRegistryRequest) Creates a registry.
CreateSchemaResult	createSchema(CreateSchemaRequest createSchemaRequest) Creates a schema definition.
DeleteDiscovererResult	deleteDiscoverer(DeleteDiscovererRequest deleteDiscovererRequest) Deletes a discoverer.
DeleteRegistryResult	deleteRegistry(DeleteRegistryRequest deleteRegistryRequest) Deletes a Registry.
DeleteSchemaResult	deleteSchema(DeleteSchemaRequest deleteSchemaRequest) Delete a schema definition.
DeleteSchemaVersionResult	deleteSchemaVersion(DeleteSchemaVersionRequest deleteSchemaVersionRequest) Delete the schema version definition
DescribeCodeBindingResult	describeCodeBinding(DescribeCodeBindingRequest describeCodeBindingRequest) Describe the code binding URI.
DescribeDiscovererResult	describeDiscoverer(DescribeDiscovererRequest describeDiscovererRequest) Describes the discoverer.
DescribeRegistryResult	describeRegistry(DescribeRegistryRequest describeRegistryRequest) Describes the registry.
DescribeSchemaResult	describeSchema(DescribeSchemaRequest describeSchemaRequest) Retrieve the schema definition.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetCodeBindingSourceResult	getCodeBindingSource(GetCodeBindingSourceRequest getCodeBindingSourceRequest) Get the code binding source URI.
GetDiscoveredSchemaResult	getDiscoveredSchema(GetDiscoveredSchemaRequest getDiscoveredSchemaRequest) Get the discovered schema that was generated based on sampled events.
ListDiscoverersResult	listDiscoverers(ListDiscoverersRequest listDiscoverersRequest) List the discoverers.
ListRegistriesResult	listRegistries(ListRegistriesRequest listRegistriesRequest) List the registries.
ListSchemasResult	listSchemas(ListSchemasRequest listSchemasRequest) List the schemas.
ListSchemaVersionsResult	listSchemaVersions(ListSchemaVersionsRequest listSchemaVersionsRequest) Provides a list of the schema versions and related information.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Get tags for resource.
LockServiceLinkedRoleResult	lockServiceLinkedRole(LockServiceLinkedRoleRequest lockServiceLinkedRoleRequest)
PutCodeBindingResult	putCodeBinding(PutCodeBindingRequest putCodeBindingRequest) Put code binding URI
SearchSchemasResult	searchSchemas(SearchSchemasRequest searchSchemasRequest) Search the schemas
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDiscovererResult	startDiscoverer(StartDiscovererRequest startDiscovererRequest) Starts the discoverer
StopDiscovererResult	stopDiscoverer(StopDiscovererRequest stopDiscovererRequest) Stops the discoverer
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Add tags to a resource.
UnlockServiceLinkedRoleResult	unlockServiceLinkedRole(UnlockServiceLinkedRoleRequest unlockServiceLinkedRoleRequest)
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a resource.
UpdateDiscovererResult	updateDiscoverer(UpdateDiscovererRequest updateDiscovererRequest) Updates the discoverer
UpdateRegistryResult	updateRegistry(UpdateRegistryRequest updateRegistryRequest) Updates a registry.
UpdateSchemaResult	updateSchema(UpdateSchemaRequest updateSchemaRequest) Updates the schema definition
AWSSchemasWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createDiscoverer

CreateDiscovererResult createDiscoverer(CreateDiscovererRequest createDiscovererRequest)

Creates a discoverer.

Parameters:

createDiscovererRequest -

Returns:

Result of the CreateDiscoverer operation returned by the service.

Throws:

BadRequestException

InternalServerErrorException

UnauthorizedException

ForbiddenException

ServiceUnavailableException

ConflictException

See Also:

AWS API Documentation

createRegistry

CreateRegistryResult createRegistry(CreateRegistryRequest createRegistryRequest)

Creates a registry.

Parameters:

createRegistryRequest -

Returns:

Result of the CreateRegistry operation returned by the service.

Throws:

BadRequestException

InternalServerErrorException

UnauthorizedException

ForbiddenException

ServiceUnavailableException

ConflictException

See Also:

AWS API Documentation

createSchema

CreateSchemaResult createSchema(CreateSchemaRequest createSchemaRequest)

Creates a schema definition.

Parameters:

createSchemaRequest -

Returns:

Result of the CreateSchema operation returned by the service.

Throws:

ServiceUnavailableException

BadRequestException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

deleteDiscoverer

DeleteDiscovererResult deleteDiscoverer(DeleteDiscovererRequest deleteDiscovererRequest)

Deletes a discoverer.

Parameters:

deleteDiscovererRequest -

Returns:

Result of the DeleteDiscoverer operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

deleteRegistry

DeleteRegistryResult deleteRegistry(DeleteRegistryRequest deleteRegistryRequest)

Deletes a Registry.

Parameters:

deleteRegistryRequest -

Returns:

Result of the DeleteRegistry operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

deleteSchema

DeleteSchemaResult deleteSchema(DeleteSchemaRequest deleteSchemaRequest)

Delete a schema definition.

Parameters:

deleteSchemaRequest -

Returns:

Result of the DeleteSchema operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

deleteSchemaVersion

DeleteSchemaVersionResult deleteSchemaVersion(DeleteSchemaVersionRequest deleteSchemaVersionRequest)

Delete the schema version definition

Parameters:

deleteSchemaVersionRequest -

Returns:

Result of the DeleteSchemaVersion operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

describeCodeBinding

DescribeCodeBindingResult describeCodeBinding(DescribeCodeBindingRequest describeCodeBindingRequest)

Describe the code binding URI.

Parameters:

describeCodeBindingRequest -

Returns:

Result of the DescribeCodeBinding operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

TooManyRequestsException

See Also:

AWS API Documentation

describeDiscoverer

DescribeDiscovererResult describeDiscoverer(DescribeDiscovererRequest describeDiscovererRequest)

Describes the discoverer.

Parameters:

describeDiscovererRequest -

Returns:

Result of the DescribeDiscoverer operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

describeRegistry

DescribeRegistryResult describeRegistry(DescribeRegistryRequest describeRegistryRequest)

Describes the registry.

Parameters:

describeRegistryRequest -

Returns:

Result of the DescribeRegistry operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

describeSchema

DescribeSchemaResult describeSchema(DescribeSchemaRequest describeSchemaRequest)

Retrieve the schema definition.

Parameters:

describeSchemaRequest -

Returns:

Result of the DescribeSchema operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

getCodeBindingSource

GetCodeBindingSourceResult getCodeBindingSource(GetCodeBindingSourceRequest getCodeBindingSourceRequest)

Get the code binding source URI.

Parameters:

getCodeBindingSourceRequest -

Returns:

Result of the GetCodeBindingSource operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

TooManyRequestsException

See Also:

AWS API Documentation

getDiscoveredSchema

GetDiscoveredSchemaResult getDiscoveredSchema(GetDiscoveredSchemaRequest getDiscoveredSchemaRequest)

Get the discovered schema that was generated based on sampled events.

Parameters:

getDiscoveredSchemaRequest -

Returns:

Result of the GetDiscoveredSchema operation returned by the service.

Throws:

ServiceUnavailableException

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

listDiscoverers

ListDiscoverersResult listDiscoverers(ListDiscoverersRequest listDiscoverersRequest)

List the discoverers.

Parameters:

listDiscoverersRequest -

Returns:

Result of the ListDiscoverers operation returned by the service.

Throws:

ServiceUnavailableException

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

listRegistries

ListRegistriesResult listRegistries(ListRegistriesRequest listRegistriesRequest)

List the registries.

Parameters:

listRegistriesRequest -

Returns:

Result of the ListRegistries operation returned by the service.

Throws:

ServiceUnavailableException

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

listSchemaVersions

ListSchemaVersionsResult listSchemaVersions(ListSchemaVersionsRequest listSchemaVersionsRequest)

Provides a list of the schema versions and related information.

Parameters:

listSchemaVersionsRequest -

Returns:

Result of the ListSchemaVersions operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

listSchemas

ListSchemasResult listSchemas(ListSchemasRequest listSchemasRequest)

List the schemas.

Parameters:

listSchemasRequest -

Returns:

Result of the ListSchemas operation returned by the service.

Throws:

ServiceUnavailableException

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Get tags for resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

NotFoundException

BadRequestException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

lockServiceLinkedRole

LockServiceLinkedRoleResult lockServiceLinkedRole(LockServiceLinkedRoleRequest lockServiceLinkedRoleRequest)

Parameters:

lockServiceLinkedRoleRequest -

Returns:

Result of the LockServiceLinkedRole operation returned by the service.

Throws:

ServiceUnavailableException

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

putCodeBinding

PutCodeBindingResult putCodeBinding(PutCodeBindingRequest putCodeBindingRequest)

Put code binding URI

Parameters:

putCodeBindingRequest -

Returns:

Result of the PutCodeBinding operation returned by the service.

Throws:

GoneException

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

TooManyRequestsException

See Also:

AWS API Documentation

searchSchemas

SearchSchemasResult searchSchemas(SearchSchemasRequest searchSchemasRequest)

Search the schemas

Parameters:

searchSchemasRequest -

Returns:

Result of the SearchSchemas operation returned by the service.

Throws:

ServiceUnavailableException

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

startDiscoverer

StartDiscovererResult startDiscoverer(StartDiscovererRequest startDiscovererRequest)

Starts the discoverer

Parameters:

startDiscovererRequest -

Returns:

Result of the StartDiscoverer operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

stopDiscoverer

StopDiscovererResult stopDiscoverer(StopDiscovererRequest stopDiscovererRequest)

Stops the discoverer

Parameters:

stopDiscovererRequest -

Returns:

Result of the StopDiscoverer operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Add tags to a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

NotFoundException

BadRequestException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

unlockServiceLinkedRole

UnlockServiceLinkedRoleResult unlockServiceLinkedRole(UnlockServiceLinkedRoleRequest unlockServiceLinkedRoleRequest)

Parameters:

unlockServiceLinkedRoleRequest -

Returns:

Result of the UnlockServiceLinkedRole operation returned by the service.

Throws:

ServiceUnavailableException

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

NotFoundException

BadRequestException

InternalServerErrorException

ForbiddenException

See Also:

AWS API Documentation

updateDiscoverer

UpdateDiscovererResult updateDiscoverer(UpdateDiscovererRequest updateDiscovererRequest)

Updates the discoverer

Parameters:

updateDiscovererRequest -

Returns:

Result of the UpdateDiscoverer operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

updateRegistry

UpdateRegistryResult updateRegistry(UpdateRegistryRequest updateRegistryRequest)

Updates a registry.

Parameters:

updateRegistryRequest -

Returns:

Result of the UpdateRegistry operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

updateSchema

UpdateSchemaResult updateSchema(UpdateSchemaRequest updateSchemaRequest)

Updates the schema definition

Parameters:

updateSchemaRequest -

Returns:

Result of the UpdateSchema operation returned by the service.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

ServiceUnavailableException

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

waiters

AWSSchemasWaiters waiters()