com.amazonaws.services.outposts

Class AWSOutpostsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.outposts.AWSOutpostsClient

All Implemented Interfaces:

AWSOutposts

Direct Known Subclasses:

AWSOutpostsAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSOutpostsClient
extends AmazonWebServiceClient
implements AWSOutposts

Client for accessing Outposts. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.outposts.AWSOutposts

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSOutpostsClientBuilder	builder()
CreateOrderResult	createOrder(CreateOrderRequest request) Creates an order for an Outpost.
CreateOutpostResult	createOutpost(CreateOutpostRequest request) Creates an Outpost.
DeleteOutpostResult	deleteOutpost(DeleteOutpostRequest request) Deletes the Outpost.
DeleteSiteResult	deleteSite(DeleteSiteRequest request) Deletes the site.
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.
GetOutpostResult	getOutpost(GetOutpostRequest request) Gets information about the specified Outpost.
GetOutpostInstanceTypesResult	getOutpostInstanceTypes(GetOutpostInstanceTypesRequest request) Lists the instance types for the specified Outpost.
ListOutpostsResult	listOutposts(ListOutpostsRequest request) Create a list of the Outposts for your AWS account.
ListSitesResult	listSites(ListSitesRequest request) Lists the sites for the specified AWS account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags for the specified resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from the specified resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSOutpostsClientBuilder builder()

createOrder

public CreateOrderResult createOrder(CreateOrderRequest request)

Creates an order for an Outpost.

Specified by:

createOrder in interface AWSOutposts

Parameters:

createOrderRequest -

Returns:

Result of the CreateOrder operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

ConflictException - Updating or deleting this resource can cause an inconsistent state.

AccessDeniedException - You do not have permission to perform this operation.

NotFoundException - The specified request is not valid.

InternalServerException - An internal error has occurred.

ServiceQuotaExceededException - You have exceeded a service quota.

See Also:

AWS API Documentation

createOutpost

public CreateOutpostResult createOutpost(CreateOutpostRequest request)

Creates an Outpost.

You can specify AvailabilityZone or AvailabilityZoneId.

Specified by:

createOutpost in interface AWSOutposts

Parameters:

createOutpostRequest -

Returns:

Result of the CreateOutpost operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

ConflictException - Updating or deleting this resource can cause an inconsistent state.

NotFoundException - The specified request is not valid.

AccessDeniedException - You do not have permission to perform this operation.

InternalServerException - An internal error has occurred.

ServiceQuotaExceededException - You have exceeded a service quota.

See Also:

AWS API Documentation

deleteOutpost

public DeleteOutpostResult deleteOutpost(DeleteOutpostRequest request)

Deletes the Outpost.

Specified by:

deleteOutpost in interface AWSOutposts

Parameters:

deleteOutpostRequest -

Returns:

Result of the DeleteOutpost operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

ConflictException - Updating or deleting this resource can cause an inconsistent state.

NotFoundException - The specified request is not valid.

AccessDeniedException - You do not have permission to perform this operation.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

deleteSite

public DeleteSiteResult deleteSite(DeleteSiteRequest request)

Deletes the site.

Specified by:

deleteSite in interface AWSOutposts

Parameters:

deleteSiteRequest -

Returns:

Result of the DeleteSite operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

ConflictException - Updating or deleting this resource can cause an inconsistent state.

NotFoundException - The specified request is not valid.

AccessDeniedException - You do not have permission to perform this operation.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

getOutpost

public GetOutpostResult getOutpost(GetOutpostRequest request)

Gets information about the specified Outpost.

Specified by:

getOutpost in interface AWSOutposts

Parameters:

getOutpostRequest -

Returns:

Result of the GetOutpost operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

AccessDeniedException - You do not have permission to perform this operation.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

getOutpostInstanceTypes

public GetOutpostInstanceTypesResult getOutpostInstanceTypes(GetOutpostInstanceTypesRequest request)

Lists the instance types for the specified Outpost.

Specified by:

getOutpostInstanceTypes in interface AWSOutposts

Parameters:

getOutpostInstanceTypesRequest -

Returns:

Result of the GetOutpostInstanceTypes operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

AccessDeniedException - You do not have permission to perform this operation.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

listOutposts

public ListOutpostsResult listOutposts(ListOutpostsRequest request)

Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a), and AZ ID (use1-az1).

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Specified by:

listOutposts in interface AWSOutposts

Parameters:

listOutpostsRequest -

Returns:

Result of the ListOutposts operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

AccessDeniedException - You do not have permission to perform this operation.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

listSites

public ListSitesResult listSites(ListSitesRequest request)

Lists the sites for the specified AWS account.

Specified by:

listSites in interface AWSOutposts

Parameters:

listSitesRequest -

Returns:

Result of the ListSites operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

AccessDeniedException - You do not have permission to perform this operation.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AWSOutposts

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - An internal error has occurred.

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds tags to the specified resource.

Specified by:

tagResource in interface AWSOutposts

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - An internal error has occurred.

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from the specified resource.

Specified by:

untagResource in interface AWSOutposts

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - An internal error has occurred.

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

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 AWSOutposts

Parameters:

request - The originally executed request

Returns:

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

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 AWSOutposts

Overrides:

shutdown in class AmazonWebServiceClient