AWSServiceDiscovery (AWS SDK for Java

All Known Subinterfaces:

AWSServiceDiscoveryAsync

All Known Implementing Classes:

AbstractAWSServiceDiscovery, AbstractAWSServiceDiscoveryAsync, AWSServiceDiscoveryAsyncClient, AWSServiceDiscoveryClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSServiceDiscovery
```
Interface for accessing ServiceDiscovery.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSServiceDiscovery instead.

AWS Cloud Map lets you configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance of the service becomes available, you can call the AWS Cloud Map API to register the instance with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateHttpNamespaceResult`	`createHttpNamespace(CreateHttpNamespaceRequest createHttpNamespaceRequest)` Creates an HTTP namespace.
`CreatePrivateDnsNamespaceResult`	`createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest createPrivateDnsNamespaceRequest)` Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC.
`CreatePublicDnsNamespaceResult`	`createPublicDnsNamespace(CreatePublicDnsNamespaceRequest createPublicDnsNamespaceRequest)` Creates a public namespace based on DNS, which will be visible on the internet.
`CreateServiceResult`	`createService(CreateServiceRequest createServiceRequest)` Creates a service, which defines the configuration for the following entities:
`DeleteNamespaceResult`	`deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)` Deletes a namespace from the current account.
`DeleteServiceResult`	`deleteService(DeleteServiceRequest deleteServiceRequest)` Deletes a specified service.
`DeregisterInstanceResult`	`deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)` Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
`DiscoverInstancesResult`	`discoverInstances(DiscoverInstancesRequest discoverInstancesRequest)` Discovers registered instances for a specified namespace and service.
`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.
`GetInstanceResult`	`getInstance(GetInstanceRequest getInstanceRequest)` Gets information about a specified instance.
`GetInstancesHealthStatusResult`	`getInstancesHealthStatus(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest)` Gets the current health status (`Healthy`, `Unhealthy`, or `Unknown`) of one or more instances that are associated with a specified service.
`GetNamespaceResult`	`getNamespace(GetNamespaceRequest getNamespaceRequest)` Gets information about a namespace.
`GetOperationResult`	`getOperation(GetOperationRequest getOperationRequest)` Gets information about any operation that returns an operation ID in the response, such as a `CreateService` request.
`GetServiceResult`	`getService(GetServiceRequest getServiceRequest)` Gets the settings for a specified service.
`ListInstancesResult`	`listInstances(ListInstancesRequest listInstancesRequest)` Lists summary information about the instances that you registered by using a specified service.
`ListNamespacesResult`	`listNamespaces(ListNamespacesRequest listNamespacesRequest)` Lists summary information about the namespaces that were created by the current AWS account.
`ListOperationsResult`	`listOperations(ListOperationsRequest listOperationsRequest)` Lists operations that match the criteria that you specify.
`ListServicesResult`	`listServices(ListServicesRequest listServicesRequest)` Lists summary information for all the services that are associated with one or more specified namespaces.
`RegisterInstanceResult`	`registerInstance(RegisterInstanceRequest registerInstanceRequest)` Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateInstanceCustomHealthStatusResult`	`updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest updateInstanceCustomHealthStatusRequest)` Submits a request to change the health status of a custom health check to healthy or unhealthy.
`UpdateServiceResult`	`updateService(UpdateServiceRequest updateServiceRequest)` Submits a request to perform the following operations:

- 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
  - createHttpNamespace
```
CreateHttpNamespaceResult createHttpNamespace(CreateHttpNamespaceRequest createHttpNamespaceRequest)
```
    Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.
    
    For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
    
    Parameters:
    
    createHttpNamespaceRequest -
    
    Returns:
    
    Result of the CreateHttpNamespace operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.
    
    ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.
    
    DuplicateRequestException - The operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - createPrivateDnsNamespace
```
CreatePrivateDnsNamespaceResult createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest createPrivateDnsNamespaceRequest)
```
    Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
    
    Parameters:
    
    createPrivateDnsNamespaceRequest -
    
    Returns:
    
    Result of the CreatePrivateDnsNamespace operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.
    
    ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.
    
    DuplicateRequestException - The operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - createPublicDnsNamespace
```
CreatePublicDnsNamespaceResult createPublicDnsNamespace(CreatePublicDnsNamespaceRequest createPublicDnsNamespaceRequest)
```
    Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
    
    Parameters:
    
    createPublicDnsNamespaceRequest -
    
    Returns:
    
    Result of the CreatePublicDnsNamespace operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.
    
    ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.
    
    DuplicateRequestException - The operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - createService
```
CreateServiceResult createService(CreateServiceRequest createServiceRequest)
```
    Creates a service, which defines the configuration for the following entities:
    - For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
      
      A
      
      AAAA
      
      A and AAAA
      
      SRV
      
      CNAME
    - Optionally, a health check
    After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.
    
    For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
    Parameters:
    
    createServiceRequest -
    
    Returns:
    
    Result of the CreateService operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.
    
    NamespaceNotFoundException - No namespace exists with the specified ID.
    
    ServiceAlreadyExistsException - The service can't be created because a service with the same name already exists.
    
    See Also:
    
    AWS API Documentation
  - deleteNamespace
```
DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
```
    Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
    
    Parameters:
    
    deleteNamespaceRequest -
    
    Returns:
    
    Result of the DeleteNamespace operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    NamespaceNotFoundException - No namespace exists with the specified ID.
    
    ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
    
    DuplicateRequestException - The operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - deleteService
```
DeleteServiceResult deleteService(DeleteServiceRequest deleteServiceRequest)
```
    Deletes a specified service. If the service still contains one or more registered instances, the request fails.
    
    Parameters:
    
    deleteServiceRequest -
    
    Returns:
    
    Result of the DeleteService operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
    
    See Also:
    
    AWS API Documentation
  - deregisterInstance
```
DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)
```
    Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
    
    Parameters:
    
    deregisterInstanceRequest -
    
    Returns:
    
    Result of the DeregisterInstance operation returned by the service.
    
    Throws:
    
    DuplicateRequestException - The operation is already in progress.
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
    
    ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    See Also:
    
    AWS API Documentation
  - discoverInstances
```
DiscoverInstancesResult discoverInstances(DiscoverInstancesRequest discoverInstancesRequest)
```
    Discovers registered instances for a specified namespace and service.
    
    Parameters:
    
    discoverInstancesRequest -
    
    Returns:
    
    Result of the DiscoverInstances operation returned by the service.
    
    Throws:
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    NamespaceNotFoundException - No namespace exists with the specified ID.
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    See Also:
    
    AWS API Documentation
  - getInstance
```
GetInstanceResult getInstance(GetInstanceRequest getInstanceRequest)
```
    Gets information about a specified instance.
    
    Parameters:
    
    getInstanceRequest -
    
    Returns:
    
    Result of the GetInstance operation returned by the service.
    
    Throws:
    
    InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    See Also:
    
    AWS API Documentation
  - getInstancesHealthStatus
```
GetInstancesHealthStatusResult getInstancesHealthStatus(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest)
```
    Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.
    
    There is a brief delay between when you register an instance and when the health status for the instance is available.
    
    Parameters:
    
    getInstancesHealthStatusRequest -
    
    Returns:
    
    Result of the GetInstancesHealthStatus operation returned by the service.
    
    Throws:
    
    InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    See Also:
    
    AWS API Documentation
  - getNamespace
```
GetNamespaceResult getNamespace(GetNamespaceRequest getNamespaceRequest)
```
    Gets information about a namespace.
    
    Parameters:
    
    getNamespaceRequest -
    
    Returns:
    
    Result of the GetNamespace operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    NamespaceNotFoundException - No namespace exists with the specified ID.
    
    See Also:
    
    AWS API Documentation
  - getOperation
```
GetOperationResult getOperation(GetOperationRequest getOperationRequest)
```
    Gets information about any operation that returns an operation ID in the response, such as a CreateService request.
    
    To get a list of operations that match specified criteria, see ListOperations.
    
    Parameters:
    
    getOperationRequest -
    
    Returns:
    
    Result of the GetOperation operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    OperationNotFoundException - No operation exists with the specified ID.
    
    See Also:
    
    AWS API Documentation
  - getService
```
GetServiceResult getService(GetServiceRequest getServiceRequest)
```
    Gets the settings for a specified service.
    
    Parameters:
    
    getServiceRequest -
    
    Returns:
    
    Result of the GetService operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    See Also:
    
    AWS API Documentation
  - listInstances
```
ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest)
```
    Lists summary information about the instances that you registered by using a specified service.
    
    Parameters:
    
    listInstancesRequest -
    
    Returns:
    
    Result of the ListInstances operation returned by the service.
    
    Throws:
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    See Also:
    
    AWS API Documentation
  - listNamespaces
```
ListNamespacesResult listNamespaces(ListNamespacesRequest listNamespacesRequest)
```
    Lists summary information about the namespaces that were created by the current AWS account.
    
    Parameters:
    
    listNamespacesRequest -
    
    Returns:
    
    Result of the ListNamespaces operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    See Also:
    
    AWS API Documentation
  - listOperations
```
ListOperationsResult listOperations(ListOperationsRequest listOperationsRequest)
```
    Lists operations that match the criteria that you specify.
    
    Parameters:
    
    listOperationsRequest -
    
    Returns:
    
    Result of the ListOperations operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    See Also:
    
    AWS API Documentation
  - listServices
```
ListServicesResult listServices(ListServicesRequest listServicesRequest)
```
    Lists summary information for all the services that are associated with one or more specified namespaces.
    
    Parameters:
    
    listServicesRequest -
    
    Returns:
    
    Result of the ListServices operation returned by the service.
    
    Throws:
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    See Also:
    
    AWS API Documentation
  - registerInstance
```
RegisterInstanceResult registerInstance(RegisterInstanceRequest registerInstanceRequest)
```
    Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs:
    - For each DNS record that you define in the service that is specified by ServiceId, a record is created or updated in the hosted zone that is associated with the corresponding namespace.
    - If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration.
    - The health check, if any, is associated with each of the new or updated records.
    One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.
    
    For more information, see CreateService.
    
    When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
    - If the health check is healthy: returns all the records
    - If the health check is unhealthy: returns the applicable value for the last healthy instance
    - If you didn't specify a health check configuration: returns all the records
    For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
    Parameters:
    
    registerInstanceRequest -
    
    Returns:
    
    Result of the RegisterInstance operation returned by the service.
    
    Throws:
    
    DuplicateRequestException - The operation is already in progress.
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
    
    ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    See Also:
    
    AWS API Documentation
  - updateInstanceCustomHealthStatus
```
UpdateInstanceCustomHealthStatusResult updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest updateInstanceCustomHealthStatusRequest)
```
    Submits a request to change the health status of a custom health check to healthy or unhealthy.
    
    You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig.
    
    For more information, see HealthCheckCustomConfig.
    
    Parameters:
    
    updateInstanceCustomHealthStatusRequest -
    
    Returns:
    
    Result of the UpdateInstanceCustomHealthStatus operation returned by the service.
    
    Throws:
    
    InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    CustomHealthNotFoundException - The health check for the instance that is specified by ServiceId and InstanceId is not a custom health check.
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    See Also:
    
    AWS API Documentation
  - updateService
```
UpdateServiceResult updateService(UpdateServiceRequest updateServiceRequest)
```
    Submits a request to perform the following operations:
    - Add or delete DnsRecords configurations
    - Update the TTL setting for existing DnsRecords configurations
    - Add, update, or delete HealthCheckConfig for a specified service
    For public and private DNS namespaces, you must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted.
    
    When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
    Parameters:
    
    updateServiceRequest -
    
    Returns:
    
    Result of the UpdateService operation returned by the service.
    
    Throws:
    
    DuplicateRequestException - The operation is already in progress.
    
    InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
    
    ServiceNotFoundException - No service exists with the specified ID.
    
    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.

Did this page help you?

Interface AWSServiceDiscovery

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createHttpNamespace

createPrivateDnsNamespace

createPublicDnsNamespace

createService

deleteNamespace

deleteService

deregisterInstance

discoverInstances

getInstance

getInstancesHealthStatus

getNamespace

getOperation

getService

listInstances

listNamespaces

listOperations

listServices

registerInstance

updateInstanceCustomHealthStatus

updateService

shutdown

getCachedResponseMetadata