Interface SupportAuthzClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface SupportAuthzClient
extends AwsClient

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

AWS Support Authorization

AWS SupportAuthZ enables you to control and authorize the actions that AWS support operators can perform on your resources. You create cryptographically signed support permits specifying which actions operators can perform, on which resources, and under what time-window conditions. Permits are signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static SupportAuthzClientBuilder	builder()	Create a builder that can be used to configure and create a SupportAuthzClient.
static SupportAuthzClient	create()	Create a SupportAuthzClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateSupportPermitResponse	createSupportPermit(Consumer<CreateSupportPermitRequest.Builder> createSupportPermitRequest)	Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources.
default CreateSupportPermitResponse	createSupportPermit(CreateSupportPermitRequest createSupportPermitRequest)	Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources.
default DeleteSupportPermitResponse	deleteSupportPermit(Consumer<DeleteSupportPermitRequest.Builder> deleteSupportPermitRequest)	Deletes a support permit, revoking the authorization previously granted to the AWS support operator.
default DeleteSupportPermitResponse	deleteSupportPermit(DeleteSupportPermitRequest deleteSupportPermitRequest)	Deletes a support permit, revoking the authorization previously granted to the AWS support operator.
default GetActionResponse	getAction(Consumer<GetActionRequest.Builder> getActionRequest)	Retrieves the description of a specific support action.
default GetActionResponse	getAction(GetActionRequest getActionRequest)	Retrieves the description of a specific support action.
default GetSupportPermitResponse	getSupportPermit(Consumer<GetSupportPermitRequest.Builder> getSupportPermitRequest)	Retrieves the details of a support permit by its ARN or name.
default GetSupportPermitResponse	getSupportPermit(GetSupportPermitRequest getSupportPermitRequest)	Retrieves the details of a support permit by its ARN or name.
default ListActionsResponse	listActions(Consumer<ListActionsRequest.Builder> listActionsRequest)	Lists available support actions for a specified AWS service.
default ListActionsResponse	listActions(ListActionsRequest listActionsRequest)	Lists available support actions for a specified AWS service.
default ListActionsIterable	listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest)	This is a variant of listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) operation.
default ListActionsIterable	listActionsPaginator(ListActionsRequest listActionsRequest)	This is a variant of listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) operation.
default ListSupportPermitRequestsResponse	listSupportPermitRequests(Consumer<ListSupportPermitRequestsRequest.Builder> listSupportPermitRequestsRequest)	Lists permit requests from AWS support operators.
default ListSupportPermitRequestsResponse	listSupportPermitRequests(ListSupportPermitRequestsRequest listSupportPermitRequestsRequest)	Lists permit requests from AWS support operators.
default ListSupportPermitRequestsIterable	listSupportPermitRequestsPaginator(Consumer<ListSupportPermitRequestsRequest.Builder> listSupportPermitRequestsRequest)	This is a variant of listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) operation.
default ListSupportPermitRequestsIterable	listSupportPermitRequestsPaginator(ListSupportPermitRequestsRequest listSupportPermitRequestsRequest)	This is a variant of listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) operation.
default ListSupportPermitsResponse	listSupportPermits(Consumer<ListSupportPermitsRequest.Builder> listSupportPermitsRequest)	Lists all support permits in the caller's account.
default ListSupportPermitsResponse	listSupportPermits(ListSupportPermitsRequest listSupportPermitsRequest)	Lists all support permits in the caller's account.
default ListSupportPermitsIterable	listSupportPermitsPaginator(Consumer<ListSupportPermitsRequest.Builder> listSupportPermitsRequest)	This is a variant of listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) operation.
default ListSupportPermitsIterable	listSupportPermitsPaginator(ListSupportPermitsRequest listSupportPermitsRequest)	This is a variant of listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags associated with a support permit resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags associated with a support permit resource.
default RejectSupportPermitRequestResponse	rejectSupportPermitRequest(Consumer<RejectSupportPermitRequestRequest.Builder> rejectSupportPermitRequestRequest)	Rejects a permit request from an AWS support operator.
default RejectSupportPermitRequestResponse	rejectSupportPermitRequest(RejectSupportPermitRequestRequest rejectSupportPermitRequestRequest)	Rejects a permit request from an AWS support operator.
default SupportAuthzServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds or overwrites one or more tags for a support permit resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or overwrites one or more tags for a support permit resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from a support permit resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from a support permit resource.

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

close

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

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createSupportPermit

default CreateSupportPermitResponse createSupportPermit(CreateSupportPermitRequest createSupportPermitRequest)
                                                 throws ValidationException,
ConflictException,
AccessDeniedException,
ThrottlingException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources. The permit is cryptographically signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.

Parameters:

createSupportPermitRequest -

Returns:

Result of the CreateSupportPermit operation returned by the service.

See Also:

• AWS API Documentation

createSupportPermit

default CreateSupportPermitResponse createSupportPermit(Consumer<CreateSupportPermitRequest.Builder> createSupportPermitRequest)
                                                 throws ValidationException,
ConflictException,
AccessDeniedException,
ThrottlingException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources. The permit is cryptographically signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.

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

Parameters:

createSupportPermitRequest - A Consumer that will call methods on CreateSupportPermitRequest.Builder to create a request.

Returns:

Result of the CreateSupportPermit operation returned by the service.

See Also:

• AWS API Documentation

deleteSupportPermit

default DeleteSupportPermitResponse deleteSupportPermit(DeleteSupportPermitRequest deleteSupportPermitRequest)
                                                 throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Deletes a support permit, revoking the authorization previously granted to the AWS support operator.

Parameters:

deleteSupportPermitRequest -

Returns:

Result of the DeleteSupportPermit operation returned by the service.

See Also:

• AWS API Documentation

deleteSupportPermit

default DeleteSupportPermitResponse deleteSupportPermit(Consumer<DeleteSupportPermitRequest.Builder> deleteSupportPermitRequest)
                                                 throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Deletes a support permit, revoking the authorization previously granted to the AWS support operator.

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

Parameters:

deleteSupportPermitRequest - A Consumer that will call methods on DeleteSupportPermitRequest.Builder to create a request.

Returns:

Result of the DeleteSupportPermit operation returned by the service.

See Also:

• AWS API Documentation

getAction

default GetActionResponse getAction(GetActionRequest getActionRequest)
                             throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Retrieves the description of a specific support action.

Parameters:

getActionRequest -

Returns:

Result of the GetAction operation returned by the service.

See Also:

• AWS API Documentation

getAction

default GetActionResponse getAction(Consumer<GetActionRequest.Builder> getActionRequest)
                             throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Retrieves the description of a specific support action.

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

Parameters:

getActionRequest - A Consumer that will call methods on GetActionRequest.Builder to create a request.

Returns:

Result of the GetAction operation returned by the service.

See Also:

• AWS API Documentation

getSupportPermit

default GetSupportPermitResponse getSupportPermit(GetSupportPermitRequest getSupportPermitRequest)
                                           throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Retrieves the details of a support permit by its ARN or name.

Parameters:

getSupportPermitRequest -

Returns:

Result of the GetSupportPermit operation returned by the service.

See Also:

• AWS API Documentation

getSupportPermit

default GetSupportPermitResponse getSupportPermit(Consumer<GetSupportPermitRequest.Builder> getSupportPermitRequest)
                                           throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Retrieves the details of a support permit by its ARN or name.

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

Parameters:

getSupportPermitRequest - A Consumer that will call methods on GetSupportPermitRequest.Builder to create a request.

Returns:

Result of the GetSupportPermit operation returned by the service.

See Also:

• AWS API Documentation

listActions

default ListActionsResponse listActions(ListActionsRequest listActionsRequest)
                                 throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Lists available support actions for a specified AWS service. Use pagination to ensure that the operation returns quickly and successfully.

Parameters:

listActionsRequest -

Returns:

Result of the ListActions operation returned by the service.

See Also:

• AWS API Documentation

listActions

default ListActionsResponse listActions(Consumer<ListActionsRequest.Builder> listActionsRequest)
                                 throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Lists available support actions for a specified AWS service. Use pagination to ensure that the operation returns quickly and successfully.

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

Parameters:

listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.

Returns:

Result of the ListActions operation returned by the service.

See Also:

• AWS API Documentation

listActionsPaginator

default ListActionsIterable listActionsPaginator(ListActionsRequest listActionsRequest)
                                          throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

This is a variant of listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) 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.supportauthz.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportauthz.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
     for (software.amazon.awssdk.services.supportauthz.model.ListActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportauthz.paginators.ListActionsIterable responses = client.listActionsPaginator(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 listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) operation.

Parameters:

listActionsRequest -

Returns:

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

See Also:

• AWS API Documentation

listActionsPaginator

default ListActionsIterable listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest)
                                          throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

This is a variant of listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) 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.supportauthz.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportauthz.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
     for (software.amazon.awssdk.services.supportauthz.model.ListActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportauthz.paginators.ListActionsIterable responses = client.listActionsPaginator(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 listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) operation.

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

Parameters:

listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listSupportPermitRequests

default ListSupportPermitRequestsResponse listSupportPermitRequests(ListSupportPermitRequestsRequest listSupportPermitRequestsRequest)
                                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Lists permit requests from AWS support operators. Use pagination to ensure that the operation returns quickly and successfully.

Parameters:

listSupportPermitRequestsRequest -

Returns:

Result of the ListSupportPermitRequests operation returned by the service.

See Also:

• AWS API Documentation

listSupportPermitRequests

default ListSupportPermitRequestsResponse listSupportPermitRequests(Consumer<ListSupportPermitRequestsRequest.Builder> listSupportPermitRequestsRequest)
                                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Lists permit requests from AWS support operators. Use pagination to ensure that the operation returns quickly and successfully.

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

Parameters:

listSupportPermitRequestsRequest - A Consumer that will call methods on ListSupportPermitRequestsRequest.Builder to create a request.

Returns:

Result of the ListSupportPermitRequests operation returned by the service.

See Also:

• AWS API Documentation

listSupportPermitRequestsPaginator

default ListSupportPermitRequestsIterable listSupportPermitRequestsPaginator(ListSupportPermitRequestsRequest listSupportPermitRequestsRequest)
                                                                      throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

This is a variant of listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) 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.supportauthz.paginators.ListSupportPermitRequestsIterable responses = client.listSupportPermitRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitRequestsIterable responses = client
             .listSupportPermitRequestsPaginator(request);
     for (software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitRequestsIterable responses = client.listSupportPermitRequestsPaginator(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 listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) operation.

Parameters:

listSupportPermitRequestsRequest -

Returns:

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

See Also:

• AWS API Documentation

listSupportPermitRequestsPaginator

default ListSupportPermitRequestsIterable listSupportPermitRequestsPaginator(Consumer<ListSupportPermitRequestsRequest.Builder> listSupportPermitRequestsRequest)
                                                                      throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

This is a variant of listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) 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.supportauthz.paginators.ListSupportPermitRequestsIterable responses = client.listSupportPermitRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitRequestsIterable responses = client
             .listSupportPermitRequestsPaginator(request);
     for (software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitRequestsIterable responses = client.listSupportPermitRequestsPaginator(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 listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) operation.

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

Parameters:

listSupportPermitRequestsRequest - A Consumer that will call methods on ListSupportPermitRequestsRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listSupportPermits

default ListSupportPermitsResponse listSupportPermits(ListSupportPermitsRequest listSupportPermitsRequest)
                                               throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.

Parameters:

listSupportPermitsRequest -

Returns:

Result of the ListSupportPermits operation returned by the service.

See Also:

• AWS API Documentation

listSupportPermits

default ListSupportPermitsResponse listSupportPermits(Consumer<ListSupportPermitsRequest.Builder> listSupportPermitsRequest)
                                               throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.

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

Parameters:

listSupportPermitsRequest - A Consumer that will call methods on ListSupportPermitsRequest.Builder to create a request.

Returns:

Result of the ListSupportPermits operation returned by the service.

See Also:

• AWS API Documentation

listSupportPermitsPaginator

default ListSupportPermitsIterable listSupportPermitsPaginator(ListSupportPermitsRequest listSupportPermitsRequest)
                                                        throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

This is a variant of listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) 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.supportauthz.paginators.ListSupportPermitsIterable responses = client.listSupportPermitsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitsIterable responses = client
             .listSupportPermitsPaginator(request);
     for (software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitsIterable responses = client.listSupportPermitsPaginator(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 listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) operation.

Parameters:

listSupportPermitsRequest -

Returns:

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

See Also:

• AWS API Documentation

listSupportPermitsPaginator

default ListSupportPermitsIterable listSupportPermitsPaginator(Consumer<ListSupportPermitsRequest.Builder> listSupportPermitsRequest)
                                                        throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

This is a variant of listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) 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.supportauthz.paginators.ListSupportPermitsIterable responses = client.listSupportPermitsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitsIterable responses = client
             .listSupportPermitsPaginator(request);
     for (software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitsIterable responses = client.listSupportPermitsPaginator(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 listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) operation.

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

Parameters:

listSupportPermitsRequest - A Consumer that will call methods on ListSupportPermitsRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Lists the tags associated with a support permit resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Lists the tags associated with a support permit 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.

See Also:

• AWS API Documentation

rejectSupportPermitRequest

default RejectSupportPermitRequestResponse rejectSupportPermitRequest(RejectSupportPermitRequestRequest rejectSupportPermitRequestRequest)
                                                               throws ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.

Parameters:

rejectSupportPermitRequestRequest -

Returns:

Result of the RejectSupportPermitRequest operation returned by the service.

See Also:

• AWS API Documentation

rejectSupportPermitRequest

default RejectSupportPermitRequestResponse rejectSupportPermitRequest(Consumer<RejectSupportPermitRequestRequest.Builder> rejectSupportPermitRequestRequest)
                                                               throws ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.

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

Parameters:

rejectSupportPermitRequestRequest - A Consumer that will call methods on RejectSupportPermitRequestRequest.Builder to create a request.

Returns:

Result of the RejectSupportPermitRequest operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Adds or overwrites one or more tags for a support permit resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Adds or overwrites one or more tags for a support permit 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.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Removes one or more tags from a support permit resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
SupportAuthzException

Removes one or more tags from a support permit 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.

See Also:

• AWS API Documentation

create

static SupportAuthzClient create()

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

builder

static SupportAuthzClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SupportAuthzServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration