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.

Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services 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()
CancelOrderResult	cancelOrder(CancelOrderRequest request) Cancels an order for an Outpost.
CreateOrderResult	createOrder(CreateOrderRequest request) Creates an order for an Outpost.
CreateOutpostResult	createOutpost(CreateOutpostRequest request) Creates an Outpost.
CreateSiteResult	createSite(CreateSiteRequest request) Creates a site for 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.
GetCatalogItemResult	getCatalogItem(GetCatalogItemRequest request) Gets information about a catalog item.
GetConnectionResult	getConnection(GetConnectionRequest request)
GetOrderResult	getOrder(GetOrderRequest request) Gets an order.
GetOutpostResult	getOutpost(GetOutpostRequest request) Gets information about the specified Outpost.
GetOutpostInstanceTypesResult	getOutpostInstanceTypes(GetOutpostInstanceTypesRequest request) Gets the instance types for the specified Outpost.
GetSiteResult	getSite(GetSiteRequest request) Gets information about the specified Outpost site.
GetSiteAddressResult	getSiteAddress(GetSiteAddressRequest request) Gets the site address.
ListAssetsResult	listAssets(ListAssetsRequest request) Lists the hardware assets in an Outpost.
ListCatalogItemsResult	listCatalogItems(ListCatalogItemsRequest request) Lists the items in the catalog.
ListOrdersResult	listOrders(ListOrdersRequest request) Lists the Outpost orders for your Amazon Web Services account.
ListOutpostsResult	listOutposts(ListOutpostsRequest request) Lists the Outposts for your Amazon Web Services account.
ListSitesResult	listSites(ListSitesRequest request) Lists the Outpost sites for your Amazon Web Services 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.
StartConnectionResult	startConnection(StartConnectionRequest request)
TagResourceResult	tagResource(TagResourceRequest request) Adds tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from the specified resource.
UpdateOutpostResult	updateOutpost(UpdateOutpostRequest request) Updates an Outpost.
UpdateSiteResult	updateSite(UpdateSiteRequest request) Updates the site.
UpdateSiteAddressResult	updateSiteAddress(UpdateSiteAddressRequest request) Updates the site address.
UpdateSiteRackPhysicalPropertiesResult	updateSiteRackPhysicalProperties(UpdateSiteRackPhysicalPropertiesRequest request) Update the physical and logistical details for a rack at a site.

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()

cancelOrder

public CancelOrderResult cancelOrder(CancelOrderRequest request)

Cancels an order for an Outpost.

Specified by:

cancelOrder in interface AWSOutposts

Parameters:

cancelOrderRequest -

Returns:

Result of the CancelOrder 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.

See Also:

AWS API Documentation

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

createSite

public CreateSiteResult createSite(CreateSiteRequest request)

Creates a site for an Outpost.

Specified by:

createSite in interface AWSOutposts

Parameters:

createSiteRequest -

Returns:

Result of the CreateSite 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.

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

getCatalogItem

public GetCatalogItemResult getCatalogItem(GetCatalogItemRequest request)

Gets information about a catalog item.

Specified by:

getCatalogItem in interface AWSOutposts

Parameters:

getCatalogItemRequest -

Returns:

Result of the GetCatalogItem operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

getConnection

public GetConnectionResult getConnection(GetConnectionRequest request)

Amazon Web Services uses this action to install Outpost servers.

Gets information about a specified connection.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

Specified by:

getConnection in interface AWSOutposts

Parameters:

getConnectionRequest -

Returns:

Result of the GetConnection operation returned by the service.

Throws:

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

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

getOrder

public GetOrderResult getOrder(GetOrderRequest request)

Gets an order.

Specified by:

getOrder in interface AWSOutposts

Parameters:

getOrderRequest -

Returns:

Result of the GetOrder operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

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)

Gets 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

getSite

public GetSiteResult getSite(GetSiteRequest request)

Gets information about the specified Outpost site.

Specified by:

getSite in interface AWSOutposts

Parameters:

getSiteRequest -

Returns:

Result of the GetSite 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

getSiteAddress

public GetSiteAddressResult getSiteAddress(GetSiteAddressRequest request)

Gets the site address.

Specified by:

getSiteAddress in interface AWSOutposts

Parameters:

getSiteAddressRequest -

Returns:

Result of the GetSiteAddress operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

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

NotFoundException - The specified request is not valid.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

listAssets

public ListAssetsResult listAssets(ListAssetsRequest request)

Lists the hardware assets in an Outpost. If you are using Dedicated Hosts on Amazon Web Services Outposts, you can filter your request by host ID to return a list of hardware assets that allocate resources for Dedicated Hosts.

Specified by:

listAssets in interface AWSOutposts

Parameters:

listAssetsRequest -

Returns:

Result of the ListAssets operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

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

NotFoundException - The specified request is not valid.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

listCatalogItems

public ListCatalogItemsResult listCatalogItems(ListCatalogItemsRequest request)

Lists the items in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.

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:

listCatalogItems in interface AWSOutposts

Parameters:

listCatalogItemsRequest -

Returns:

Result of the ListCatalogItems operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

listOrders

public ListOrdersResult listOrders(ListOrdersRequest request)

Lists the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to return a more specific list of results.

Specified by:

listOrders in interface AWSOutposts

Parameters:

listOrdersRequest -

Returns:

Result of the ListOrders 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)

Lists the Outposts for your Amazon Web Services account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availability 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 Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address.

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:

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

startConnection

public StartConnectionResult startConnection(StartConnectionRequest request)

Amazon Web Services uses this action to install Outpost servers.

Starts the connection required for Outpost server installation.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

Specified by:

startConnection in interface AWSOutposts

Parameters:

startConnectionRequest -

Returns:

Result of the StartConnection operation returned by the service.

Throws:

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

ValidationException - A parameter is not valid.

NotFoundException - The specified request is not valid.

InternalServerException - An internal error has occurred.

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

updateOutpost

public UpdateOutpostResult updateOutpost(UpdateOutpostRequest request)

Updates an Outpost.

Specified by:

updateOutpost in interface AWSOutposts

Parameters:

updateOutpostRequest -

Returns:

Result of the UpdateOutpost 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

updateSite

public UpdateSiteResult updateSite(UpdateSiteRequest request)

Updates the site.

Specified by:

updateSite in interface AWSOutposts

Parameters:

updateSiteRequest -

Returns:

Result of the UpdateSite 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

updateSiteAddress

public UpdateSiteAddressResult updateSiteAddress(UpdateSiteAddressRequest request)

Updates the site address.

To update a site address with an order IN_PROGRESS, you must wait for the order to complete or cancel the order.

You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.

Specified by:

updateSiteAddress in interface AWSOutposts

Parameters:

updateSiteAddressRequest -

Returns:

Result of the UpdateSiteAddress operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

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

NotFoundException - The specified request is not valid.

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

InternalServerException - An internal error has occurred.

See Also:

AWS API Documentation

updateSiteRackPhysicalProperties

public UpdateSiteRackPhysicalPropertiesResult updateSiteRackPhysicalProperties(UpdateSiteRackPhysicalPropertiesRequest request)

Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.

Specified by:

updateSiteRackPhysicalProperties in interface AWSOutposts

Parameters:

updateSiteRackPhysicalPropertiesRequest -

Returns:

Result of the UpdateSiteRackPhysicalProperties 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

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