AWSSchemasClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.schemas.AWSSchemasClient

All Implemented Interfaces:

AWSSchemas

Direct Known Subclasses:

AWSSchemasAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSchemasClient
extends AmazonWebServiceClient
implements AWSSchemas
```
Client for accessing Schemas. All service calls made using this client are blocking, and will not return until the service call completes.

AWS EventBridge Schemas

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.schemas.AWSSchemas
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSSchemasClientBuilder`	`builder()`
`CreateDiscovererResult`	`createDiscoverer(CreateDiscovererRequest request)` Creates a discoverer.
`CreateRegistryResult`	`createRegistry(CreateRegistryRequest request)` Creates a registry.
`CreateSchemaResult`	`createSchema(CreateSchemaRequest request)` Creates a schema definition.
`DeleteDiscovererResult`	`deleteDiscoverer(DeleteDiscovererRequest request)` Deletes a discoverer.
`DeleteRegistryResult`	`deleteRegistry(DeleteRegistryRequest request)` Deletes a Registry.
`DeleteSchemaResult`	`deleteSchema(DeleteSchemaRequest request)` Delete a schema definition.
`DeleteSchemaVersionResult`	`deleteSchemaVersion(DeleteSchemaVersionRequest request)` Delete the schema version definition
`DescribeCodeBindingResult`	`describeCodeBinding(DescribeCodeBindingRequest request)` Describe the code binding URI.
`DescribeDiscovererResult`	`describeDiscoverer(DescribeDiscovererRequest request)` Describes the discoverer.
`DescribeRegistryResult`	`describeRegistry(DescribeRegistryRequest request)` Describes the registry.
`DescribeSchemaResult`	`describeSchema(DescribeSchemaRequest request)` 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 request)` Get the code binding source URI.
`GetDiscoveredSchemaResult`	`getDiscoveredSchema(GetDiscoveredSchemaRequest request)` Get the discovered schema that was generated based on sampled events.
`ListDiscoverersResult`	`listDiscoverers(ListDiscoverersRequest request)` List the discoverers.
`ListRegistriesResult`	`listRegistries(ListRegistriesRequest request)` List the registries.
`ListSchemasResult`	`listSchemas(ListSchemasRequest request)` List the schemas.
`ListSchemaVersionsResult`	`listSchemaVersions(ListSchemaVersionsRequest request)` Provides a list of the schema versions and related information.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Get tags for resource.
`LockServiceLinkedRoleResult`	`lockServiceLinkedRole(LockServiceLinkedRoleRequest request)`
`PutCodeBindingResult`	`putCodeBinding(PutCodeBindingRequest request)` Put code binding URI
`SearchSchemasResult`	`searchSchemas(SearchSchemasRequest request)` Search the schemas
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDiscovererResult`	`startDiscoverer(StartDiscovererRequest request)` Starts the discoverer
`StopDiscovererResult`	`stopDiscoverer(StopDiscovererRequest request)` Stops the discoverer
`TagResourceResult`	`tagResource(TagResourceRequest request)` Add tags to a resource.
`UnlockServiceLinkedRoleResult`	`unlockServiceLinkedRole(UnlockServiceLinkedRoleRequest request)`
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from a resource.
`UpdateDiscovererResult`	`updateDiscoverer(UpdateDiscovererRequest request)` Updates the discoverer
`UpdateRegistryResult`	`updateRegistry(UpdateRegistryRequest request)` Updates a registry.
`UpdateSchemaResult`	`updateSchema(UpdateSchemaRequest request)` Updates the schema definition
`AWSSchemasWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSSchemasClientBuilder builder()
```
  - createDiscoverer
```
public CreateDiscovererResult createDiscoverer(CreateDiscovererRequest request)
```
    Creates a discoverer.
    
    Specified by:
    
    createDiscoverer in interface AWSSchemas
    
    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
```
public CreateRegistryResult createRegistry(CreateRegistryRequest request)
```
    Creates a registry.
    
    Specified by:
    
    createRegistry in interface AWSSchemas
    
    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
```
public CreateSchemaResult createSchema(CreateSchemaRequest request)
```
    Creates a schema definition.
    
    Specified by:
    
    createSchema in interface AWSSchemas
    
    Parameters:
    
    createSchemaRequest -
    
    Returns:
    
    Result of the CreateSchema operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException
    
    BadRequestException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - deleteDiscoverer
```
public DeleteDiscovererResult deleteDiscoverer(DeleteDiscovererRequest request)
```
    Deletes a discoverer.
    
    Specified by:
    
    deleteDiscoverer in interface AWSSchemas
    
    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
```
public DeleteRegistryResult deleteRegistry(DeleteRegistryRequest request)
```
    Deletes a Registry.
    
    Specified by:
    
    deleteRegistry in interface AWSSchemas
    
    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
```
public DeleteSchemaResult deleteSchema(DeleteSchemaRequest request)
```
    Delete a schema definition.
    
    Specified by:
    
    deleteSchema in interface AWSSchemas
    
    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
```
public DeleteSchemaVersionResult deleteSchemaVersion(DeleteSchemaVersionRequest request)
```
    Delete the schema version definition
    
    Specified by:
    
    deleteSchemaVersion in interface AWSSchemas
    
    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
```
public DescribeCodeBindingResult describeCodeBinding(DescribeCodeBindingRequest request)
```
    Describe the code binding URI.
    
    Specified by:
    
    describeCodeBinding in interface AWSSchemas
    
    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
```
public DescribeDiscovererResult describeDiscoverer(DescribeDiscovererRequest request)
```
    Describes the discoverer.
    
    Specified by:
    
    describeDiscoverer in interface AWSSchemas
    
    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
```
public DescribeRegistryResult describeRegistry(DescribeRegistryRequest request)
```
    Describes the registry.
    
    Specified by:
    
    describeRegistry in interface AWSSchemas
    
    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
```
public DescribeSchemaResult describeSchema(DescribeSchemaRequest request)
```
    Retrieve the schema definition.
    
    Specified by:
    
    describeSchema in interface AWSSchemas
    
    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
```
public GetCodeBindingSourceResult getCodeBindingSource(GetCodeBindingSourceRequest request)
```
    Get the code binding source URI.
    
    Specified by:
    
    getCodeBindingSource in interface AWSSchemas
    
    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
```
public GetDiscoveredSchemaResult getDiscoveredSchema(GetDiscoveredSchemaRequest request)
```
    Get the discovered schema that was generated based on sampled events.
    
    Specified by:
    
    getDiscoveredSchema in interface AWSSchemas
    
    Parameters:
    
    getDiscoveredSchemaRequest -
    
    Returns:
    
    Result of the GetDiscoveredSchema operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException
    
    BadRequestException
    
    UnauthorizedException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - listDiscoverers
```
public ListDiscoverersResult listDiscoverers(ListDiscoverersRequest request)
```
    List the discoverers.
    
    Specified by:
    
    listDiscoverers in interface AWSSchemas
    
    Parameters:
    
    listDiscoverersRequest -
    
    Returns:
    
    Result of the ListDiscoverers operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException
    
    BadRequestException
    
    UnauthorizedException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - listRegistries
```
public ListRegistriesResult listRegistries(ListRegistriesRequest request)
```
    List the registries.
    
    Specified by:
    
    listRegistries in interface AWSSchemas
    
    Parameters:
    
    listRegistriesRequest -
    
    Returns:
    
    Result of the ListRegistries operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException
    
    BadRequestException
    
    UnauthorizedException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - listSchemaVersions
```
public ListSchemaVersionsResult listSchemaVersions(ListSchemaVersionsRequest request)
```
    Provides a list of the schema versions and related information.
    
    Specified by:
    
    listSchemaVersions in interface AWSSchemas
    
    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
```
public ListSchemasResult listSchemas(ListSchemasRequest request)
```
    List the schemas.
    
    Specified by:
    
    listSchemas in interface AWSSchemas
    
    Parameters:
    
    listSchemasRequest -
    
    Returns:
    
    Result of the ListSchemas operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException
    
    BadRequestException
    
    UnauthorizedException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Get tags for resource.
    
    Specified by:
    
    listTagsForResource in interface AWSSchemas
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    NotFoundException
    
    BadRequestException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - lockServiceLinkedRole
```
public LockServiceLinkedRoleResult lockServiceLinkedRole(LockServiceLinkedRoleRequest request)
```
    Specified by:
    
    lockServiceLinkedRole in interface AWSSchemas
    
    Parameters:
    
    lockServiceLinkedRoleRequest -
    
    Returns:
    
    Result of the LockServiceLinkedRole operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException
    
    BadRequestException
    
    UnauthorizedException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - putCodeBinding
```
public PutCodeBindingResult putCodeBinding(PutCodeBindingRequest request)
```
    Put code binding URI
    
    Specified by:
    
    putCodeBinding in interface AWSSchemas
    
    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
```
public SearchSchemasResult searchSchemas(SearchSchemasRequest request)
```
    Search the schemas
    
    Specified by:
    
    searchSchemas in interface AWSSchemas
    
    Parameters:
    
    searchSchemasRequest -
    
    Returns:
    
    Result of the SearchSchemas operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException
    
    BadRequestException
    
    UnauthorizedException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - startDiscoverer
```
public StartDiscovererResult startDiscoverer(StartDiscovererRequest request)
```
    Starts the discoverer
    
    Specified by:
    
    startDiscoverer in interface AWSSchemas
    
    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
```
public StopDiscovererResult stopDiscoverer(StopDiscovererRequest request)
```
    Stops the discoverer
    
    Specified by:
    
    stopDiscoverer in interface AWSSchemas
    
    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
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Add tags to a resource.
    
    Specified by:
    
    tagResource in interface AWSSchemas
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    NotFoundException
    
    BadRequestException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - unlockServiceLinkedRole
```
public UnlockServiceLinkedRoleResult unlockServiceLinkedRole(UnlockServiceLinkedRoleRequest request)
```
    Specified by:
    
    unlockServiceLinkedRole in interface AWSSchemas
    
    Parameters:
    
    unlockServiceLinkedRoleRequest -
    
    Returns:
    
    Result of the UnlockServiceLinkedRole operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException
    
    BadRequestException
    
    UnauthorizedException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes tags from a resource.
    
    Specified by:
    
    untagResource in interface AWSSchemas
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    NotFoundException
    
    BadRequestException
    
    InternalServerErrorException
    
    ForbiddenException
    
    See Also:
    
    AWS API Documentation
  - updateDiscoverer
```
public UpdateDiscovererResult updateDiscoverer(UpdateDiscovererRequest request)
```
    Updates the discoverer
    
    Specified by:
    
    updateDiscoverer in interface AWSSchemas
    
    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
```
public UpdateRegistryResult updateRegistry(UpdateRegistryRequest request)
```
    Updates a registry.
    
    Specified by:
    
    updateRegistry in interface AWSSchemas
    
    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
```
public UpdateSchemaResult updateSchema(UpdateSchemaRequest request)
```
    Updates the schema definition
    
    Specified by:
    
    updateSchema in interface AWSSchemas
    
    Parameters:
    
    updateSchemaRequest -
    
    Returns:
    
    Result of the UpdateSchema operation returned by the service.
    
    Throws:
    
    BadRequestException
    
    InternalServerErrorException
    
    ForbiddenException
    
    NotFoundException
    
    ServiceUnavailableException
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSSchemas
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AWSSchemasWaiters waiters()
```
    Specified by:
    
    waiters in interface AWSSchemas
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSSchemas
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSSchemasClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.schemas.AWSSchemas

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

createDiscoverer

createRegistry

createSchema

deleteDiscoverer

deleteRegistry

deleteSchema

deleteSchemaVersion

describeCodeBinding

describeDiscoverer

describeRegistry

describeSchema

getCodeBindingSource

getDiscoveredSchema

listDiscoverers

listRegistries

listSchemaVersions

listSchemas

listTagsForResource

lockServiceLinkedRole

putCodeBinding

searchSchemas

startDiscoverer

stopDiscoverer

tagResource

unlockServiceLinkedRole

untagResource

updateDiscoverer

updateRegistry

updateSchema

getCachedResponseMetadata

waiters

shutdown