com.amazonaws.services.outposts

Interface AWSOutposts

All Known Subinterfaces:

AWSOutpostsAsync

All Known Implementing Classes:

AbstractAWSOutposts, AbstractAWSOutpostsAsync, AWSOutpostsAsyncClient, AWSOutpostsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSOutposts

Interface for accessing Outposts.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSOutposts instead.

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

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

Method Summary

Modifier and Type	Method and Description
CancelCapacityTaskResult	cancelCapacityTask(CancelCapacityTaskRequest cancelCapacityTaskRequest) Cancels the capacity task.
CancelOrderResult	cancelOrder(CancelOrderRequest cancelOrderRequest) Cancels the specified order for an Outpost.
CreateOrderResult	createOrder(CreateOrderRequest createOrderRequest) Creates an order for an Outpost.
CreateOutpostResult	createOutpost(CreateOutpostRequest createOutpostRequest) Creates an Outpost.
CreateSiteResult	createSite(CreateSiteRequest createSiteRequest) Creates a site for an Outpost.
DeleteOutpostResult	deleteOutpost(DeleteOutpostRequest deleteOutpostRequest) Deletes the specified Outpost.
DeleteSiteResult	deleteSite(DeleteSiteRequest deleteSiteRequest) Deletes the specified 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.
GetCapacityTaskResult	getCapacityTask(GetCapacityTaskRequest getCapacityTaskRequest) Gets details of the specified capacity task.
GetCatalogItemResult	getCatalogItem(GetCatalogItemRequest getCatalogItemRequest) Gets information about the specified catalog item.
GetConnectionResult	getConnection(GetConnectionRequest getConnectionRequest)
GetOrderResult	getOrder(GetOrderRequest getOrderRequest) Gets information about the specified order.
GetOutpostResult	getOutpost(GetOutpostRequest getOutpostRequest) Gets information about the specified Outpost.
GetOutpostInstanceTypesResult	getOutpostInstanceTypes(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest) Gets the instance types for the specified Outpost.
GetOutpostSupportedInstanceTypesResult	getOutpostSupportedInstanceTypes(GetOutpostSupportedInstanceTypesRequest getOutpostSupportedInstanceTypesRequest) Gets the instance types that an Outpost can support in InstanceTypeCapacity.
GetSiteResult	getSite(GetSiteRequest getSiteRequest) Gets information about the specified Outpost site.
GetSiteAddressResult	getSiteAddress(GetSiteAddressRequest getSiteAddressRequest) Gets the site address of the specified site.
ListAssetsResult	listAssets(ListAssetsRequest listAssetsRequest) Lists the hardware assets for the specified Outpost.
ListCapacityTasksResult	listCapacityTasks(ListCapacityTasksRequest listCapacityTasksRequest) Lists the capacity tasks for your Amazon Web Services account.
ListCatalogItemsResult	listCatalogItems(ListCatalogItemsRequest listCatalogItemsRequest) Lists the items in the catalog.
ListOrdersResult	listOrders(ListOrdersRequest listOrdersRequest) Lists the Outpost orders for your Amazon Web Services account.
ListOutpostsResult	listOutposts(ListOutpostsRequest listOutpostsRequest) Lists the Outposts for your Amazon Web Services account.
ListSitesResult	listSites(ListSitesRequest listSitesRequest) Lists the Outpost sites for your Amazon Web Services account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartCapacityTaskResult	startCapacityTask(StartCapacityTaskRequest startCapacityTaskRequest) Starts the specified capacity task.
StartConnectionResult	startConnection(StartConnectionRequest startConnectionRequest)
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the specified resource.
UpdateOutpostResult	updateOutpost(UpdateOutpostRequest updateOutpostRequest) Updates an Outpost.
UpdateSiteResult	updateSite(UpdateSiteRequest updateSiteRequest) Updates the specified site.
UpdateSiteAddressResult	updateSiteAddress(UpdateSiteAddressRequest updateSiteAddressRequest) Updates the address of the specified site.
UpdateSiteRackPhysicalPropertiesResult	updateSiteRackPhysicalProperties(UpdateSiteRackPhysicalPropertiesRequest updateSiteRackPhysicalPropertiesRequest) Update the physical and logistical details for a rack at a site.

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

cancelCapacityTask

CancelCapacityTaskResult cancelCapacityTask(CancelCapacityTaskRequest cancelCapacityTaskRequest)

Cancels the capacity task.

Parameters:

cancelCapacityTaskRequest -

Returns:

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

cancelOrder

CancelOrderResult cancelOrder(CancelOrderRequest cancelOrderRequest)

Cancels the specified order for an Outpost.

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

CreateOrderResult createOrder(CreateOrderRequest createOrderRequest)

Creates an order for an Outpost.

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

CreateOutpostResult createOutpost(CreateOutpostRequest createOutpostRequest)

Creates an Outpost.

You can specify either an Availability one or an AZ ID.

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

CreateSiteResult createSite(CreateSiteRequest createSiteRequest)

Creates a site for an Outpost.

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

DeleteOutpostResult deleteOutpost(DeleteOutpostRequest deleteOutpostRequest)

Deletes the specified Outpost.

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

DeleteSiteResult deleteSite(DeleteSiteRequest deleteSiteRequest)

Deletes the specified site.

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

getCapacityTask

GetCapacityTaskResult getCapacityTask(GetCapacityTaskRequest getCapacityTaskRequest)

Gets details of the specified capacity task.

Parameters:

getCapacityTaskRequest -

Returns:

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

getCatalogItem

GetCatalogItemResult getCatalogItem(GetCatalogItemRequest getCatalogItemRequest)

Gets information about the specified catalog item.

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

GetConnectionResult getConnection(GetConnectionRequest getConnectionRequest)

Amazon Web Services uses this action to install Outpost servers.

Gets information about the 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.

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

GetOrderResult getOrder(GetOrderRequest getOrderRequest)

Gets information about the specified order.

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

GetOutpostResult getOutpost(GetOutpostRequest getOutpostRequest)

Gets information about the specified Outpost.

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

GetOutpostInstanceTypesResult getOutpostInstanceTypes(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest)

Gets the instance types for the specified Outpost.

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

getOutpostSupportedInstanceTypes

GetOutpostSupportedInstanceTypesResult getOutpostSupportedInstanceTypes(GetOutpostSupportedInstanceTypesRequest getOutpostSupportedInstanceTypesRequest)

Gets the instance types that an Outpost can support in InstanceTypeCapacity. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.

Parameters:

getOutpostSupportedInstanceTypesRequest -

Returns:

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

getSite

GetSiteResult getSite(GetSiteRequest getSiteRequest)

Gets information about the specified Outpost site.

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

GetSiteAddressResult getSiteAddress(GetSiteAddressRequest getSiteAddressRequest)

Gets the site address of the specified site.

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

ListAssetsResult listAssets(ListAssetsRequest listAssetsRequest)

Lists the hardware assets for the specified Outpost.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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

listCapacityTasks

ListCapacityTasksResult listCapacityTasks(ListCapacityTasksRequest listCapacityTasksRequest)

Lists the capacity tasks for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Parameters:

listCapacityTasksRequest -

Returns:

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

ListCatalogItemsResult listCatalogItems(ListCatalogItemsRequest listCatalogItemsRequest)

Lists the items in the catalog.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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

ListOrdersResult listOrders(ListOrdersRequest listOrdersRequest)

Lists the Outpost orders for your Amazon Web Services account.

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

ListOutpostsResult listOutposts(ListOutpostsRequest listOutpostsRequest)

Lists the Outposts for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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

ListSitesResult listSites(ListSitesRequest listSitesRequest)

Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified resource.

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

startCapacityTask

StartCapacityTaskResult startCapacityTask(StartCapacityTaskRequest startCapacityTaskRequest)

Starts the specified capacity task. You can have one active capacity task for an order.

Parameters:

startCapacityTaskRequest -

Returns:

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

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

See Also:

AWS API Documentation

startConnection

StartConnectionResult startConnection(StartConnectionRequest startConnectionRequest)

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.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds tags to the specified resource.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from the specified resource.

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

UpdateOutpostResult updateOutpost(UpdateOutpostRequest updateOutpostRequest)

Updates an Outpost.

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

UpdateSiteResult updateSite(UpdateSiteRequest updateSiteRequest)

Updates the specified site.

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

UpdateSiteAddressResult updateSiteAddress(UpdateSiteAddressRequest updateSiteAddressRequest)

Updates the address of the specified site.

You can't update a site address if there is 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.

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

UpdateSiteRackPhysicalPropertiesResult updateSiteRackPhysicalProperties(UpdateSiteRackPhysicalPropertiesRequest updateSiteRackPhysicalPropertiesRequest)

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.

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

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.