AbstractAWSOutposts (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.outposts

Class AbstractAWSOutposts

java.lang.Object
- com.amazonaws.services.outposts.AbstractAWSOutposts

All Implemented Interfaces:

AWSOutposts

Direct Known Subclasses:

AbstractAWSOutpostsAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSOutposts
extends Object
implements AWSOutposts 
```
Abstract implementation of AWSOutposts. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.outposts.AWSOutposts
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`CancelCapacityTaskResult`	`cancelCapacityTask (CancelCapacityTaskRequest request)` Cancels the capacity task.
`CancelOrderResult`	`cancelOrder (CancelOrderRequest request)` Cancels the specified 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 specified Outpost.
`DeleteSiteResult`	`deleteSite (DeleteSiteRequest request)` 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 request)` Gets details of the specified capacity task.
`GetCatalogItemResult`	`getCatalogItem (GetCatalogItemRequest request)` Gets information about the specified catalog item.
`GetConnectionResult`	`getConnection (GetConnectionRequest request)`
`GetOrderResult`	`getOrder (GetOrderRequest request)` Gets information about the specified order.
`GetOutpostResult`	`getOutpost (GetOutpostRequest request)` Gets information about the specified Outpost.
`GetOutpostInstanceTypesResult`	`getOutpostInstanceTypes (GetOutpostInstanceTypesRequest request)` Gets the instance types for the specified Outpost.
`GetOutpostSupportedInstanceTypesResult`	`getOutpostSupportedInstanceTypes (GetOutpostSupportedInstanceTypesRequest request)` Gets the instance types that an Outpost can support in `InstanceTypeCapacity`.
`GetSiteResult`	`getSite (GetSiteRequest request)` Gets information about the specified Outpost site.
`GetSiteAddressResult`	`getSiteAddress (GetSiteAddressRequest request)` Gets the site address of the specified site.
`ListAssetsResult`	`listAssets (ListAssetsRequest request)` Lists the hardware assets for the specified Outpost.
`ListCapacityTasksResult`	`listCapacityTasks (ListCapacityTasksRequest request)` Lists the capacity tasks for your Amazon Web Services account.
`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.
`StartCapacityTaskResult`	`startCapacityTask (StartCapacityTaskRequest request)` Starts the specified capacity task.
`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 specified site.
`UpdateSiteAddressResult`	`updateSiteAddress (UpdateSiteAddressRequest request)` Updates the address of the specified site.
`UpdateSiteRackPhysicalPropertiesResult`	`updateSiteRackPhysicalProperties (UpdateSiteRackPhysicalPropertiesRequest request)` Update the physical and logistical details for a rack at a site.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - cancelCapacityTask
```
public CancelCapacityTaskResult cancelCapacityTask(CancelCapacityTaskRequest request)
```
    Description copied from interface: AWSOutposts
    
    Cancels the capacity task.
    
    Specified by:
    
    cancelCapacityTask in interface AWSOutposts
    
    Returns:
    
    Result of the CancelCapacityTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelOrder
```
public CancelOrderResult cancelOrder(CancelOrderRequest request)
```
    Description copied from interface: AWSOutposts
    
    Cancels the specified order for an Outpost.
    
    Specified by:
    
    cancelOrder in interface AWSOutposts
    
    Returns:
    
    Result of the CancelOrder operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createOrder
```
public CreateOrderResult createOrder(CreateOrderRequest request)
```
    Description copied from interface: AWSOutposts
    
    Creates an order for an Outpost.
    
    Specified by:
    
    createOrder in interface AWSOutposts
    
    Returns:
    
    Result of the CreateOrder operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createOutpost
```
public CreateOutpostResult createOutpost(CreateOutpostRequest request)
```
    Description copied from interface: AWSOutposts
    
    Creates an Outpost.
    
    You can specify either an Availability one or an AZ ID.
    
    Specified by:
    
    createOutpost in interface AWSOutposts
    
    Returns:
    
    Result of the CreateOutpost operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSite
```
public CreateSiteResult createSite(CreateSiteRequest request)
```
    Description copied from interface: AWSOutposts
    
    Creates a site for an Outpost.
    
    Specified by:
    
    createSite in interface AWSOutposts
    
    Returns:
    
    Result of the CreateSite operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteOutpost
```
public DeleteOutpostResult deleteOutpost(DeleteOutpostRequest request)
```
    Description copied from interface: AWSOutposts
    
    Deletes the specified Outpost.
    
    Specified by:
    
    deleteOutpost in interface AWSOutposts
    
    Returns:
    
    Result of the DeleteOutpost operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSite
```
public DeleteSiteResult deleteSite(DeleteSiteRequest request)
```
    Description copied from interface: AWSOutposts
    
    Deletes the specified site.
    
    Specified by:
    
    deleteSite in interface AWSOutposts
    
    Returns:
    
    Result of the DeleteSite operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCapacityTask
```
public GetCapacityTaskResult getCapacityTask(GetCapacityTaskRequest request)
```
    Description copied from interface: AWSOutposts
    
    Gets details of the specified capacity task.
    
    Specified by:
    
    getCapacityTask in interface AWSOutposts
    
    Returns:
    
    Result of the GetCapacityTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCatalogItem
```
public GetCatalogItemResult getCatalogItem(GetCatalogItemRequest request)
```
    Description copied from interface: AWSOutposts
    
    Gets information about the specified catalog item.
    
    Specified by:
    
    getCatalogItem in interface AWSOutposts
    
    Returns:
    
    Result of the GetCatalogItem operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getConnection
```
public GetConnectionResult getConnection(GetConnectionRequest request)
```
    Description copied from interface: AWSOutposts
    
    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.
    
    Specified by:
    
    getConnection in interface AWSOutposts
    
    Returns:
    
    Result of the GetConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getOrder
```
public GetOrderResult getOrder(GetOrderRequest request)
```
    Description copied from interface: AWSOutposts
    
    Gets information about the specified order.
    
    Specified by:
    
    getOrder in interface AWSOutposts
    
    Returns:
    
    Result of the GetOrder operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getOutpost
```
public GetOutpostResult getOutpost(GetOutpostRequest request)
```
    Description copied from interface: AWSOutposts
    
    Gets information about the specified Outpost.
    
    Specified by:
    
    getOutpost in interface AWSOutposts
    
    Returns:
    
    Result of the GetOutpost operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getOutpostInstanceTypes
```
public GetOutpostInstanceTypesResult getOutpostInstanceTypes(GetOutpostInstanceTypesRequest request)
```
    Description copied from interface: AWSOutposts
    
    Gets the instance types for the specified Outpost.
    
    Specified by:
    
    getOutpostInstanceTypes in interface AWSOutposts
    
    Returns:
    
    Result of the GetOutpostInstanceTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getOutpostSupportedInstanceTypes
```
public GetOutpostSupportedInstanceTypesResult getOutpostSupportedInstanceTypes(GetOutpostSupportedInstanceTypesRequest request)
```
    Description copied from interface: AWSOutposts
    
    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.
    
    Specified by:
    
    getOutpostSupportedInstanceTypes in interface AWSOutposts
    
    Returns:
    
    Result of the GetOutpostSupportedInstanceTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSite
```
public GetSiteResult getSite(GetSiteRequest request)
```
    Description copied from interface: AWSOutposts
    
    Gets information about the specified Outpost site.
    
    Specified by:
    
    getSite in interface AWSOutposts
    
    Returns:
    
    Result of the GetSite operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSiteAddress
```
public GetSiteAddressResult getSiteAddress(GetSiteAddressRequest request)
```
    Description copied from interface: AWSOutposts
    
    Gets the site address of the specified site.
    
    Specified by:
    
    getSiteAddress in interface AWSOutposts
    
    Returns:
    
    Result of the GetSiteAddress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssets
```
public ListAssetsResult listAssets(ListAssetsRequest request)
```
    Description copied from interface: AWSOutposts
    
    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.
    
    Specified by:
    
    listAssets in interface AWSOutposts
    
    Returns:
    
    Result of the ListAssets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCapacityTasks
```
public ListCapacityTasksResult listCapacityTasks(ListCapacityTasksRequest request)
```
    Description copied from interface: AWSOutposts
    
    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.
    
    Specified by:
    
    listCapacityTasks in interface AWSOutposts
    
    Returns:
    
    Result of the ListCapacityTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCatalogItems
```
public ListCatalogItemsResult listCatalogItems(ListCatalogItemsRequest request)
```
    Description copied from interface: AWSOutposts
    
    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.
    
    Specified by:
    
    listCatalogItems in interface AWSOutposts
    
    Returns:
    
    Result of the ListCatalogItems operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listOrders
```
public ListOrdersResult listOrders(ListOrdersRequest request)
```
    Description copied from interface: AWSOutposts
    
    Lists the Outpost orders for your Amazon Web Services account.
    
    Specified by:
    
    listOrders in interface AWSOutposts
    
    Returns:
    
    Result of the ListOrders operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listOutposts
```
public ListOutpostsResult listOutposts(ListOutpostsRequest request)
```
    Description copied from interface: AWSOutposts
    
    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.
    
    Specified by:
    
    listOutposts in interface AWSOutposts
    
    Returns:
    
    Result of the ListOutposts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSites
```
public ListSitesResult listSites(ListSitesRequest request)
```
    Description copied from interface: AWSOutposts
    
    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.
    
    Specified by:
    
    listSites in interface AWSOutposts
    
    Returns:
    
    Result of the ListSites operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSOutposts
    
    Lists the tags for the specified resource.
    
    Specified by:
    
    listTagsForResource in interface AWSOutposts
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startCapacityTask
```
public StartCapacityTaskResult startCapacityTask(StartCapacityTaskRequest request)
```
    Description copied from interface: AWSOutposts
    
    Starts the specified capacity task. You can have one active capacity task for an order.
    
    Specified by:
    
    startCapacityTask in interface AWSOutposts
    
    Returns:
    
    Result of the StartCapacityTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startConnection
```
public StartConnectionResult startConnection(StartConnectionRequest request)
```
    Description copied from interface: AWSOutposts
    
    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
    
    Returns:
    
    Result of the StartConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSOutposts
    
    Adds tags to the specified resource.
    
    Specified by:
    
    tagResource in interface AWSOutposts
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSOutposts
    
    Removes tags from the specified resource.
    
    Specified by:
    
    untagResource in interface AWSOutposts
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateOutpost
```
public UpdateOutpostResult updateOutpost(UpdateOutpostRequest request)
```
    Description copied from interface: AWSOutposts
    
    Updates an Outpost.
    
    Specified by:
    
    updateOutpost in interface AWSOutposts
    
    Returns:
    
    Result of the UpdateOutpost operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSite
```
public UpdateSiteResult updateSite(UpdateSiteRequest request)
```
    Description copied from interface: AWSOutposts
    
    Updates the specified site.
    
    Specified by:
    
    updateSite in interface AWSOutposts
    
    Returns:
    
    Result of the UpdateSite operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSiteAddress
```
public UpdateSiteAddressResult updateSiteAddress(UpdateSiteAddressRequest request)
```
    Description copied from interface: AWSOutposts
    
    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.
    
    Specified by:
    
    updateSiteAddress in interface AWSOutposts
    
    Returns:
    
    Result of the UpdateSiteAddress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSiteRackPhysicalProperties
```
public UpdateSiteRackPhysicalPropertiesResult updateSiteRackPhysicalProperties(UpdateSiteRackPhysicalPropertiesRequest request)
```
    Description copied from interface: AWSOutposts
    
    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
    
    Returns:
    
    Result of the UpdateSiteRackPhysicalProperties operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSOutposts
    
    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.
    
    Specified by:
    
    shutdown in interface AWSOutposts
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSOutposts
    
    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.
    
    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.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AbstractAWSOutposts

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cancelCapacityTask

cancelOrder

createOrder

createOutpost

createSite

deleteOutpost

deleteSite

getCapacityTask

getCatalogItem

getConnection

getOrder

getOutpost

getOutpostInstanceTypes

getOutpostSupportedInstanceTypes

getSite

getSiteAddress

listAssets

listCapacityTasks

listCatalogItems

listOrders

listOutposts

listSites

listTagsForResource

startCapacityTask

startConnection

tagResource

untagResource

updateOutpost

updateSite

updateSiteAddress

updateSiteRackPhysicalProperties

shutdown

getCachedResponseMetadata