com.amazonaws.services.schemas.AWSSchemas Maven / Gradle / Ivy
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.schemas;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.schemas.model.*;
import com.amazonaws.services.schemas.waiters.AWSSchemasWaiters;
/**
* Interface for accessing Schemas.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.schemas.AbstractAWSSchemas} instead.
*
*
*
* Amazon EventBridge Schema Registry
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSchemas {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "schemas";
/**
*
* Creates a discoverer.
*
*
* @param createDiscovererRequest
* @return Result of the CreateDiscoverer operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws InternalServerErrorException
* 500 response
* @throws UnauthorizedException
* 401 response
* @throws ForbiddenException
* 403 response
* @throws ServiceUnavailableException
* 503 response
* @throws ConflictException
* 409 response
* @sample AWSSchemas.CreateDiscoverer
* @see AWS API
* Documentation
*/
CreateDiscovererResult createDiscoverer(CreateDiscovererRequest createDiscovererRequest);
/**
*
* Creates a registry.
*
*
* @param createRegistryRequest
* @return Result of the CreateRegistry operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws InternalServerErrorException
* 500 response
* @throws UnauthorizedException
* 401 response
* @throws ForbiddenException
* 403 response
* @throws ServiceUnavailableException
* 503 response
* @throws ConflictException
* 409 response
* @sample AWSSchemas.CreateRegistry
* @see AWS API
* Documentation
*/
CreateRegistryResult createRegistry(CreateRegistryRequest createRegistryRequest);
/**
*
* Creates a schema definition.
*
*
*
* Inactive schemas will be deleted after two years.
*
*
*
* @param createSchemaRequest
* @return Result of the CreateSchema operation returned by the service.
* @throws ServiceUnavailableException
* 503 response
* @throws BadRequestException
* 400 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @sample AWSSchemas.CreateSchema
* @see AWS API
* Documentation
*/
CreateSchemaResult createSchema(CreateSchemaRequest createSchemaRequest);
/**
*
* Deletes a discoverer.
*
*
* @param deleteDiscovererRequest
* @return Result of the DeleteDiscoverer operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.DeleteDiscoverer
* @see AWS API
* Documentation
*/
DeleteDiscovererResult deleteDiscoverer(DeleteDiscovererRequest deleteDiscovererRequest);
/**
*
* Deletes a Registry.
*
*
* @param deleteRegistryRequest
* @return Result of the DeleteRegistry operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.DeleteRegistry
* @see AWS API
* Documentation
*/
DeleteRegistryResult deleteRegistry(DeleteRegistryRequest deleteRegistryRequest);
/**
*
* Delete the resource-based policy attached to the specified registry.
*
*
* @param deleteResourcePolicyRequest
* @return Result of the DeleteResourcePolicy operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.DeleteResourcePolicy
* @see AWS
* API Documentation
*/
DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest);
/**
*
* Delete a schema definition.
*
*
* @param deleteSchemaRequest
* @return Result of the DeleteSchema operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.DeleteSchema
* @see AWS API
* Documentation
*/
DeleteSchemaResult deleteSchema(DeleteSchemaRequest deleteSchemaRequest);
/**
*
* Delete the schema version definition
*
*
* @param deleteSchemaVersionRequest
* @return Result of the DeleteSchemaVersion operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.DeleteSchemaVersion
* @see AWS
* API Documentation
*/
DeleteSchemaVersionResult deleteSchemaVersion(DeleteSchemaVersionRequest deleteSchemaVersionRequest);
/**
*
* Describe the code binding URI.
*
*
* @param describeCodeBindingRequest
* @return Result of the DescribeCodeBinding operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws TooManyRequestsException
* 429 response
* @sample AWSSchemas.DescribeCodeBinding
* @see AWS
* API Documentation
*/
DescribeCodeBindingResult describeCodeBinding(DescribeCodeBindingRequest describeCodeBindingRequest);
/**
*
* Describes the discoverer.
*
*
* @param describeDiscovererRequest
* @return Result of the DescribeDiscoverer operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.DescribeDiscoverer
* @see AWS API
* Documentation
*/
DescribeDiscovererResult describeDiscoverer(DescribeDiscovererRequest describeDiscovererRequest);
/**
*
* Describes the registry.
*
*
* @param describeRegistryRequest
* @return Result of the DescribeRegistry operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.DescribeRegistry
* @see AWS API
* Documentation
*/
DescribeRegistryResult describeRegistry(DescribeRegistryRequest describeRegistryRequest);
/**
*
* Retrieve the schema definition.
*
*
* @param describeSchemaRequest
* @return Result of the DescribeSchema operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.DescribeSchema
* @see AWS API
* Documentation
*/
DescribeSchemaResult describeSchema(DescribeSchemaRequest describeSchemaRequest);
/**
* @param exportSchemaRequest
* @return Result of the ExportSchema operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @throws TooManyRequestsException
* 429 response
* @sample AWSSchemas.ExportSchema
* @see AWS API
* Documentation
*/
ExportSchemaResult exportSchema(ExportSchemaRequest exportSchemaRequest);
/**
*
* Get the code binding source URI.
*
*
* @param getCodeBindingSourceRequest
* @return Result of the GetCodeBindingSource operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws TooManyRequestsException
* 429 response
* @sample AWSSchemas.GetCodeBindingSource
* @see AWS
* API Documentation
*/
GetCodeBindingSourceResult getCodeBindingSource(GetCodeBindingSourceRequest getCodeBindingSourceRequest);
/**
*
* Get the discovered schema that was generated based on sampled events.
*
*
* @param getDiscoveredSchemaRequest
* @return Result of the GetDiscoveredSchema operation returned by the service.
* @throws ServiceUnavailableException
* 503 response
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @sample AWSSchemas.GetDiscoveredSchema
* @see AWS
* API Documentation
*/
GetDiscoveredSchemaResult getDiscoveredSchema(GetDiscoveredSchemaRequest getDiscoveredSchemaRequest);
/**
*
* Retrieves the resource-based policy attached to a given registry.
*
*
* @param getResourcePolicyRequest
* @return Result of the GetResourcePolicy operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.GetResourcePolicy
* @see AWS API
* Documentation
*/
GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest);
/**
*
* List the discoverers.
*
*
* @param listDiscoverersRequest
* @return Result of the ListDiscoverers operation returned by the service.
* @throws ServiceUnavailableException
* 503 response
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @sample AWSSchemas.ListDiscoverers
* @see AWS API
* Documentation
*/
ListDiscoverersResult listDiscoverers(ListDiscoverersRequest listDiscoverersRequest);
/**
*
* List the registries.
*
*
* @param listRegistriesRequest
* @return Result of the ListRegistries operation returned by the service.
* @throws ServiceUnavailableException
* 503 response
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @sample AWSSchemas.ListRegistries
* @see AWS API
* Documentation
*/
ListRegistriesResult listRegistries(ListRegistriesRequest listRegistriesRequest);
/**
*
* Provides a list of the schema versions and related information.
*
*
* @param listSchemaVersionsRequest
* @return Result of the ListSchemaVersions operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.ListSchemaVersions
* @see AWS API
* Documentation
*/
ListSchemaVersionsResult listSchemaVersions(ListSchemaVersionsRequest listSchemaVersionsRequest);
/**
*
* List the schemas.
*
*
* @param listSchemasRequest
* @return Result of the ListSchemas operation returned by the service.
* @throws ServiceUnavailableException
* 503 response
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @sample AWSSchemas.ListSchemas
* @see AWS API
* Documentation
*/
ListSchemasResult listSchemas(ListSchemasRequest listSchemasRequest);
/**
*
* Get tags for resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws BadRequestException
* 400 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @sample AWSSchemas.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Put code binding URI
*
*
* @param putCodeBindingRequest
* @return Result of the PutCodeBinding operation returned by the service.
* @throws GoneException
* 410 response
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws TooManyRequestsException
* 429 response
* @sample AWSSchemas.PutCodeBinding
* @see AWS API
* Documentation
*/
PutCodeBindingResult putCodeBinding(PutCodeBindingRequest putCodeBindingRequest);
/**
*
* The name of the policy.
*
*
* @param putResourcePolicyRequest
* The name of the policy.
* @return Result of the PutResourcePolicy operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws PreconditionFailedException
* 412 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.PutResourcePolicy
* @see AWS API
* Documentation
*/
PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest);
/**
*
* Search the schemas
*
*
* @param searchSchemasRequest
* @return Result of the SearchSchemas operation returned by the service.
* @throws ServiceUnavailableException
* 503 response
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @sample AWSSchemas.SearchSchemas
* @see AWS API
* Documentation
*/
SearchSchemasResult searchSchemas(SearchSchemasRequest searchSchemasRequest);
/**
*
* Starts the discoverer
*
*
* @param startDiscovererRequest
* @return Result of the StartDiscoverer operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.StartDiscoverer
* @see AWS API
* Documentation
*/
StartDiscovererResult startDiscoverer(StartDiscovererRequest startDiscovererRequest);
/**
*
* Stops the discoverer
*
*
* @param stopDiscovererRequest
* @return Result of the StopDiscoverer operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.StopDiscoverer
* @see AWS API
* Documentation
*/
StopDiscovererResult stopDiscoverer(StopDiscovererRequest stopDiscovererRequest);
/**
*
* Add tags to a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws BadRequestException
* 400 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @sample AWSSchemas.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes tags from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws BadRequestException
* 400 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @sample AWSSchemas.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the discoverer
*
*
* @param updateDiscovererRequest
* @return Result of the UpdateDiscoverer operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.UpdateDiscoverer
* @see AWS API
* Documentation
*/
UpdateDiscovererResult updateDiscoverer(UpdateDiscovererRequest updateDiscovererRequest);
/**
*
* Updates a registry.
*
*
* @param updateRegistryRequest
* Updates the registry.
* @return Result of the UpdateRegistry operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws UnauthorizedException
* 401 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.UpdateRegistry
* @see AWS API
* Documentation
*/
UpdateRegistryResult updateRegistry(UpdateRegistryRequest updateRegistryRequest);
/**
*
* Updates the schema definition
*
*
*
* Inactive schemas will be deleted after two years.
*
*
*
* @param updateSchemaRequest
* @return Result of the UpdateSchema operation returned by the service.
* @throws BadRequestException
* 400 response
* @throws InternalServerErrorException
* 500 response
* @throws ForbiddenException
* 403 response
* @throws NotFoundException
* 404 response
* @throws ServiceUnavailableException
* 503 response
* @sample AWSSchemas.UpdateSchema
* @see AWS API
* Documentation
*/
UpdateSchemaResult updateSchema(UpdateSchemaRequest updateSchemaRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
AWSSchemasWaiters waiters();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy