software.amazon.awssdk.services.outposts

Interface OutpostsClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface OutpostsClient
extends SdkClient

Service client for accessing Outposts. This can be created using the static builder() method.

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

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static OutpostsClientBuilder	builder() Create a builder that can be used to configure and create a OutpostsClient.
static OutpostsClient	create() Create a OutpostsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateOutpostResponse	createOutpost(Consumer<CreateOutpostRequest.Builder> createOutpostRequest) Creates an Outpost.
default CreateOutpostResponse	createOutpost(CreateOutpostRequest createOutpostRequest) Creates an Outpost.
default DeleteOutpostResponse	deleteOutpost(Consumer<DeleteOutpostRequest.Builder> deleteOutpostRequest) Deletes the Outpost.
default DeleteOutpostResponse	deleteOutpost(DeleteOutpostRequest deleteOutpostRequest) Deletes the Outpost.
default DeleteSiteResponse	deleteSite(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest) Deletes the site.
default DeleteSiteResponse	deleteSite(DeleteSiteRequest deleteSiteRequest) Deletes the site.
default GetOutpostResponse	getOutpost(Consumer<GetOutpostRequest.Builder> getOutpostRequest) Gets information about the specified Outpost.
default GetOutpostResponse	getOutpost(GetOutpostRequest getOutpostRequest) Gets information about the specified Outpost.
default GetOutpostInstanceTypesResponse	getOutpostInstanceTypes(Consumer<GetOutpostInstanceTypesRequest.Builder> getOutpostInstanceTypesRequest) Lists the instance types for the specified Outpost.
default GetOutpostInstanceTypesResponse	getOutpostInstanceTypes(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest) Lists the instance types for the specified Outpost.
default ListOutpostsResponse	listOutposts(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest) List the Outposts for your AWS account.
default ListOutpostsResponse	listOutposts(ListOutpostsRequest listOutpostsRequest) List the Outposts for your AWS account.
default ListOutpostsIterable	listOutpostsPaginator(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest) List the Outposts for your AWS account.
default ListOutpostsIterable	listOutpostsPaginator(ListOutpostsRequest listOutpostsRequest) List the Outposts for your AWS account.
default ListSitesResponse	listSites(Consumer<ListSitesRequest.Builder> listSitesRequest) Lists the sites for the specified AWS account.
default ListSitesResponse	listSites(ListSitesRequest listSitesRequest) Lists the sites for the specified AWS account.
default ListSitesIterable	listSitesPaginator(Consumer<ListSitesRequest.Builder> listSitesRequest) Lists the sites for the specified AWS account.
default ListSitesIterable	listSitesPaginator(ListSitesRequest listSitesRequest) Lists the sites for the specified AWS account.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds tags to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest) Adds tags to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the specified resource.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static OutpostsClient create()

Create a OutpostsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static OutpostsClientBuilder builder()

Create a builder that can be used to configure and create a OutpostsClient.

createOutpost

default CreateOutpostResponse createOutpost(CreateOutpostRequest createOutpostRequest)
                                     throws ValidationException,
                                            NotFoundException,
                                            AccessDeniedException,
                                            InternalServerException,
                                            ServiceQuotaExceededException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OutpostsException

Creates an Outpost.

Parameters:

createOutpostRequest -

Returns:

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

ServiceQuotaExceededException - You have exceeded a service quota.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createOutpost

default CreateOutpostResponse createOutpost(Consumer<CreateOutpostRequest.Builder> createOutpostRequest)
                                     throws ValidationException,
                                            NotFoundException,
                                            AccessDeniedException,
                                            InternalServerException,
                                            ServiceQuotaExceededException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OutpostsException

Creates an Outpost.

This is a convenience which creates an instance of the CreateOutpostRequest.Builder avoiding the need to create one manually via CreateOutpostRequest.builder()

Parameters:

createOutpostRequest - A Consumer that will call methods on CreateOutpostInput.Builder to create a request.

Returns:

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

ServiceQuotaExceededException - You have exceeded a service quota.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteOutpost

default DeleteOutpostResponse deleteOutpost(DeleteOutpostRequest deleteOutpostRequest)
                                     throws ValidationException,
                                            NotFoundException,
                                            AccessDeniedException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OutpostsException

Deletes the Outpost.

Parameters:

deleteOutpostRequest -

Returns:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteOutpost

default DeleteOutpostResponse deleteOutpost(Consumer<DeleteOutpostRequest.Builder> deleteOutpostRequest)
                                     throws ValidationException,
                                            NotFoundException,
                                            AccessDeniedException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OutpostsException

Deletes the Outpost.

This is a convenience which creates an instance of the DeleteOutpostRequest.Builder avoiding the need to create one manually via DeleteOutpostRequest.builder()

Parameters:

deleteOutpostRequest - A Consumer that will call methods on DeleteOutpostInput.Builder to create a request.

Returns:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteSite

default DeleteSiteResponse deleteSite(DeleteSiteRequest deleteSiteRequest)
                               throws ValidationException,
                                      NotFoundException,
                                      AccessDeniedException,
                                      InternalServerException,
                                      AwsServiceException,
                                      SdkClientException,
                                      OutpostsException

Deletes the site.

Parameters:

deleteSiteRequest -

Returns:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteSite

default DeleteSiteResponse deleteSite(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest)
                               throws ValidationException,
                                      NotFoundException,
                                      AccessDeniedException,
                                      InternalServerException,
                                      AwsServiceException,
                                      SdkClientException,
                                      OutpostsException

Deletes the site.

This is a convenience which creates an instance of the DeleteSiteRequest.Builder avoiding the need to create one manually via DeleteSiteRequest.builder()

Parameters:

deleteSiteRequest - A Consumer that will call methods on DeleteSiteInput.Builder to create a request.

Returns:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getOutpost

default GetOutpostResponse getOutpost(GetOutpostRequest getOutpostRequest)
                               throws ValidationException,
                                      NotFoundException,
                                      AccessDeniedException,
                                      InternalServerException,
                                      AwsServiceException,
                                      SdkClientException,
                                      OutpostsException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getOutpost

default GetOutpostResponse getOutpost(Consumer<GetOutpostRequest.Builder> getOutpostRequest)
                               throws ValidationException,
                                      NotFoundException,
                                      AccessDeniedException,
                                      InternalServerException,
                                      AwsServiceException,
                                      SdkClientException,
                                      OutpostsException

Gets information about the specified Outpost.

This is a convenience which creates an instance of the GetOutpostRequest.Builder avoiding the need to create one manually via GetOutpostRequest.builder()

Parameters:

getOutpostRequest - A Consumer that will call methods on GetOutpostInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getOutpostInstanceTypes

default GetOutpostInstanceTypesResponse getOutpostInstanceTypes(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest)
                                                         throws ValidationException,
                                                                NotFoundException,
                                                                AccessDeniedException,
                                                                InternalServerException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OutpostsException

Lists 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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getOutpostInstanceTypes

default GetOutpostInstanceTypesResponse getOutpostInstanceTypes(Consumer<GetOutpostInstanceTypesRequest.Builder> getOutpostInstanceTypesRequest)
                                                         throws ValidationException,
                                                                NotFoundException,
                                                                AccessDeniedException,
                                                                InternalServerException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OutpostsException

Lists the instance types for the specified Outpost.

This is a convenience which creates an instance of the GetOutpostInstanceTypesRequest.Builder avoiding the need to create one manually via GetOutpostInstanceTypesRequest.builder()

Parameters:

getOutpostInstanceTypesRequest - A Consumer that will call methods on GetOutpostInstanceTypesInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listOutposts

default ListOutpostsResponse listOutposts(ListOutpostsRequest listOutpostsRequest)
                                   throws ValidationException,
                                          AccessDeniedException,
                                          InternalServerException,
                                          AwsServiceException,
                                          SdkClientException,
                                          OutpostsException

List the Outposts for your AWS account.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listOutposts

default ListOutpostsResponse listOutposts(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest)
                                   throws ValidationException,
                                          AccessDeniedException,
                                          InternalServerException,
                                          AwsServiceException,
                                          SdkClientException,
                                          OutpostsException

List the Outposts for your AWS account.

This is a convenience which creates an instance of the ListOutpostsRequest.Builder avoiding the need to create one manually via ListOutpostsRequest.builder()

Parameters:

listOutpostsRequest - A Consumer that will call methods on ListOutpostsInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listOutpostsPaginator

default ListOutpostsIterable listOutpostsPaginator(ListOutpostsRequest listOutpostsRequest)
                                            throws ValidationException,
                                                   AccessDeniedException,
                                                   InternalServerException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   OutpostsException

List the Outposts for your AWS account.

This is a variant of listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.outposts.paginators.ListOutpostsIterable responses = client.listOutpostsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.outposts.paginators.ListOutpostsIterable responses = client.listOutpostsPaginator(request);
     for (software.amazon.awssdk.services.outposts.model.ListOutpostsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.outposts.paginators.ListOutpostsIterable responses = client.listOutpostsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest) operation.

Parameters:

listOutpostsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - A parameter is not valid.

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

InternalServerException - An internal error has occurred.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listOutpostsPaginator

default ListOutpostsIterable listOutpostsPaginator(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest)
                                            throws ValidationException,
                                                   AccessDeniedException,
                                                   InternalServerException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   OutpostsException

List the Outposts for your AWS account.

This is a variant of listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.outposts.paginators.ListOutpostsIterable responses = client.listOutpostsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.outposts.paginators.ListOutpostsIterable responses = client.listOutpostsPaginator(request);
     for (software.amazon.awssdk.services.outposts.model.ListOutpostsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.outposts.paginators.ListOutpostsIterable responses = client.listOutpostsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest) operation.

This is a convenience which creates an instance of the ListOutpostsRequest.Builder avoiding the need to create one manually via ListOutpostsRequest.builder()

Parameters:

listOutpostsRequest - A Consumer that will call methods on ListOutpostsInput.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - A parameter is not valid.

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

InternalServerException - An internal error has occurred.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSites

default ListSitesResponse listSites(ListSitesRequest listSitesRequest)
                             throws ValidationException,
                                    AccessDeniedException,
                                    InternalServerException,
                                    AwsServiceException,
                                    SdkClientException,
                                    OutpostsException

Lists the sites for the specified AWS account.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSites

default ListSitesResponse listSites(Consumer<ListSitesRequest.Builder> listSitesRequest)
                             throws ValidationException,
                                    AccessDeniedException,
                                    InternalServerException,
                                    AwsServiceException,
                                    SdkClientException,
                                    OutpostsException

Lists the sites for the specified AWS account.

This is a convenience which creates an instance of the ListSitesRequest.Builder avoiding the need to create one manually via ListSitesRequest.builder()

Parameters:

listSitesRequest - A Consumer that will call methods on ListSitesInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSitesPaginator

default ListSitesIterable listSitesPaginator(ListSitesRequest listSitesRequest)
                                      throws ValidationException,
                                             AccessDeniedException,
                                             InternalServerException,
                                             AwsServiceException,
                                             SdkClientException,
                                             OutpostsException

Lists the sites for the specified AWS account.

This is a variant of listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.outposts.paginators.ListSitesIterable responses = client.listSitesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.outposts.paginators.ListSitesIterable responses = client.listSitesPaginator(request);
     for (software.amazon.awssdk.services.outposts.model.ListSitesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.outposts.paginators.ListSitesIterable responses = client.listSitesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest) operation.

Parameters:

listSitesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - A parameter is not valid.

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

InternalServerException - An internal error has occurred.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSitesPaginator

default ListSitesIterable listSitesPaginator(Consumer<ListSitesRequest.Builder> listSitesRequest)
                                      throws ValidationException,
                                             AccessDeniedException,
                                             InternalServerException,
                                             AwsServiceException,
                                             SdkClientException,
                                             OutpostsException

Lists the sites for the specified AWS account.

This is a variant of listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.outposts.paginators.ListSitesIterable responses = client.listSitesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.outposts.paginators.ListSitesIterable responses = client.listSitesPaginator(request);
     for (software.amazon.awssdk.services.outposts.model.ListSitesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.outposts.paginators.ListSitesIterable responses = client.listSitesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest) operation.

This is a convenience which creates an instance of the ListSitesRequest.Builder avoiding the need to create one manually via ListSitesRequest.builder()

Parameters:

listSitesRequest - A Consumer that will call methods on ListSitesInput.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - A parameter is not valid.

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

InternalServerException - An internal error has occurred.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
                                                        ValidationException,
                                                        NotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        OutpostsException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
                                                        ValidationException,
                                                        NotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        OutpostsException

Lists the tags for the specified resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
                                        ValidationException,
                                        NotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        OutpostsException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
                                        ValidationException,
                                        NotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        OutpostsException

Adds tags to the specified resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
                                            ValidationException,
                                            NotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OutpostsException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
                                            ValidationException,
                                            NotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OutpostsException

Removes tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()