Package software.amazon.awssdk.services.pcaconnectorscep

Interface PcaConnectorScepClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing Private CA Connector for SCEP. This can be created using the static builder() method.

Connector for SCEP (Preview) is in preview release for Amazon Web Services Private Certificate Authority and is subject to change.

Connector for SCEP (Preview) creates a connector between Amazon Web Services Private CA and your SCEP-enabled clients and devices. For more information, see Connector for SCEP in the Amazon Web Services Private CA User Guide.

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 PcaConnectorScepClientBuilder	builder()	Create a builder that can be used to configure and create a PcaConnectorScepClient.
static PcaConnectorScepClient	create()	Create a PcaConnectorScepClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateChallengeResponse	createChallenge(Consumer<CreateChallengeRequest.Builder> createChallengeRequest)	For general-purpose connectors.
default CreateChallengeResponse	createChallenge(CreateChallengeRequest createChallengeRequest)	For general-purpose connectors.
default CreateConnectorResponse	createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest)	Creates a SCEP connector.
default CreateConnectorResponse	createConnector(CreateConnectorRequest createConnectorRequest)	Creates a SCEP connector.
default DeleteChallengeResponse	deleteChallenge(Consumer<DeleteChallengeRequest.Builder> deleteChallengeRequest)	Deletes the specified Challenge.
default DeleteChallengeResponse	deleteChallenge(DeleteChallengeRequest deleteChallengeRequest)	Deletes the specified Challenge.
default DeleteConnectorResponse	deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest)	Deletes the specified Connector.
default DeleteConnectorResponse	deleteConnector(DeleteConnectorRequest deleteConnectorRequest)	Deletes the specified Connector.
default GetChallengeMetadataResponse	getChallengeMetadata(Consumer<GetChallengeMetadataRequest.Builder> getChallengeMetadataRequest)	Retrieves the metadata for the specified Challenge.
default GetChallengeMetadataResponse	getChallengeMetadata(GetChallengeMetadataRequest getChallengeMetadataRequest)	Retrieves the metadata for the specified Challenge.
default GetChallengePasswordResponse	getChallengePassword(Consumer<GetChallengePasswordRequest.Builder> getChallengePasswordRequest)	Retrieves the challenge password for the specified Challenge.
default GetChallengePasswordResponse	getChallengePassword(GetChallengePasswordRequest getChallengePasswordRequest)	Retrieves the challenge password for the specified Challenge.
default GetConnectorResponse	getConnector(Consumer<GetConnectorRequest.Builder> getConnectorRequest)	Retrieves details about the specified Connector.
default GetConnectorResponse	getConnector(GetConnectorRequest getConnectorRequest)	Retrieves details about the specified Connector.
default ListChallengeMetadataResponse	listChallengeMetadata(Consumer<ListChallengeMetadataRequest.Builder> listChallengeMetadataRequest)	Retrieves the challenge metadata for the specified ARN.
default ListChallengeMetadataResponse	listChallengeMetadata(ListChallengeMetadataRequest listChallengeMetadataRequest)	Retrieves the challenge metadata for the specified ARN.
default ListChallengeMetadataIterable	listChallengeMetadataPaginator(Consumer<ListChallengeMetadataRequest.Builder> listChallengeMetadataRequest)	This is a variant of listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest) operation.
default ListChallengeMetadataIterable	listChallengeMetadataPaginator(ListChallengeMetadataRequest listChallengeMetadataRequest)	This is a variant of listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest) operation.
default ListConnectorsResponse	listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)	Lists the connectors belonging to your Amazon Web Services account.
default ListConnectorsResponse	listConnectors(ListConnectorsRequest listConnectorsRequest)	Lists the connectors belonging to your Amazon Web Services account.
default ListConnectorsIterable	listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)	This is a variant of listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest) operation.
default ListConnectorsIterable	listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)	This is a variant of listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Retrieves the tags associated with the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Retrieves the tags associated with the specified resource.
default PcaConnectorScepServiceClientConfiguration	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 one or more tags to your resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds one or more tags to your resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from your resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from your 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

createChallenge

default CreateChallengeResponse createChallenge(CreateChallengeRequest createChallengeRequest)
                                         throws ResourceNotFoundException,
BadRequestException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

For general-purpose connectors. Creates a challenge password for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call ListConnectors.

To create additional challenge passwords for the connector, call CreateChallenge again. We recommend frequently rotating your challenge passwords.

Parameters:

createChallengeRequest -

Returns:

Result of the CreateChallenge operation returned by the service.

See Also:

• AWS API Documentation

createChallenge

default CreateChallengeResponse createChallenge(Consumer<CreateChallengeRequest.Builder> createChallengeRequest)
                                         throws ResourceNotFoundException,
BadRequestException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

For general-purpose connectors. Creates a challenge password for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call ListConnectors.

To create additional challenge passwords for the connector, call CreateChallenge again. We recommend frequently rotating your challenge passwords.

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

Parameters:

createChallengeRequest - A Consumer that will call methods on CreateChallengeRequest.Builder to create a request.

Returns:

Result of the CreateChallenge operation returned by the service.

See Also:

• AWS API Documentation

createConnector

default CreateConnectorResponse createConnector(CreateConnectorRequest createConnectorRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see Connector for SCEP prerequisites.

Parameters:

createConnectorRequest -

Returns:

Result of the CreateConnector operation returned by the service.

See Also:

• AWS API Documentation

createConnector

default CreateConnectorResponse createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see Connector for SCEP prerequisites.

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

Parameters:

createConnectorRequest - A Consumer that will call methods on CreateConnectorRequest.Builder to create a request.

Returns:

Result of the CreateConnector operation returned by the service.

See Also:

• AWS API Documentation

deleteChallenge

default DeleteChallengeResponse deleteChallenge(DeleteChallengeRequest deleteChallengeRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Deletes the specified Challenge.

Parameters:

deleteChallengeRequest -

Returns:

Result of the DeleteChallenge operation returned by the service.

See Also:

• AWS API Documentation

deleteChallenge

default DeleteChallengeResponse deleteChallenge(Consumer<DeleteChallengeRequest.Builder> deleteChallengeRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Deletes the specified Challenge.

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

Parameters:

deleteChallengeRequest - A Consumer that will call methods on DeleteChallengeRequest.Builder to create a request.

Returns:

Result of the DeleteChallenge operation returned by the service.

See Also:

• AWS API Documentation

deleteConnector

default DeleteConnectorResponse deleteConnector(DeleteConnectorRequest deleteConnectorRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Deletes the specified Connector. This operation also deletes any challenges associated with the connector.

Parameters:

deleteConnectorRequest -

Returns:

Result of the DeleteConnector operation returned by the service.

See Also:

• AWS API Documentation

deleteConnector

default DeleteConnectorResponse deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Deletes the specified Connector. This operation also deletes any challenges associated with the connector.

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

Parameters:

deleteConnectorRequest - A Consumer that will call methods on DeleteConnectorRequest.Builder to create a request.

Returns:

Result of the DeleteConnector operation returned by the service.

See Also:

• AWS API Documentation

getChallengeMetadata

default GetChallengeMetadataResponse getChallengeMetadata(GetChallengeMetadataRequest getChallengeMetadataRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves the metadata for the specified Challenge.

Parameters:

getChallengeMetadataRequest -

Returns:

Result of the GetChallengeMetadata operation returned by the service.

See Also:

• AWS API Documentation

getChallengeMetadata

default GetChallengeMetadataResponse getChallengeMetadata(Consumer<GetChallengeMetadataRequest.Builder> getChallengeMetadataRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves the metadata for the specified Challenge.

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

Parameters:

getChallengeMetadataRequest - A Consumer that will call methods on GetChallengeMetadataRequest.Builder to create a request.

Returns:

Result of the GetChallengeMetadata operation returned by the service.

See Also:

• AWS API Documentation

getChallengePassword

default GetChallengePasswordResponse getChallengePassword(GetChallengePasswordRequest getChallengePasswordRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves the challenge password for the specified Challenge.

Parameters:

getChallengePasswordRequest -

Returns:

Result of the GetChallengePassword operation returned by the service.

See Also:

• AWS API Documentation

getChallengePassword

default GetChallengePasswordResponse getChallengePassword(Consumer<GetChallengePasswordRequest.Builder> getChallengePasswordRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves the challenge password for the specified Challenge.

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

Parameters:

getChallengePasswordRequest - A Consumer that will call methods on GetChallengePasswordRequest.Builder to create a request.

Returns:

Result of the GetChallengePassword operation returned by the service.

See Also:

• AWS API Documentation

getConnector

default GetConnectorResponse getConnector(GetConnectorRequest getConnectorRequest)
                                   throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.

Parameters:

getConnectorRequest -

Returns:

Result of the GetConnector operation returned by the service.

See Also:

• AWS API Documentation

getConnector

default GetConnectorResponse getConnector(Consumer<GetConnectorRequest.Builder> getConnectorRequest)
                                   throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.

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

Parameters:

getConnectorRequest - A Consumer that will call methods on GetConnectorRequest.Builder to create a request.

Returns:

Result of the GetConnector operation returned by the service.

See Also:

• AWS API Documentation

listChallengeMetadata

default ListChallengeMetadataResponse listChallengeMetadata(ListChallengeMetadataRequest listChallengeMetadataRequest)
                                                     throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves the challenge metadata for the specified ARN.

Parameters:

listChallengeMetadataRequest -

Returns:

Result of the ListChallengeMetadata operation returned by the service.

See Also:

• AWS API Documentation

listChallengeMetadata

default ListChallengeMetadataResponse listChallengeMetadata(Consumer<ListChallengeMetadataRequest.Builder> listChallengeMetadataRequest)
                                                     throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves the challenge metadata for the specified ARN.

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

Parameters:

listChallengeMetadataRequest - A Consumer that will call methods on ListChallengeMetadataRequest.Builder to create a request.

Returns:

Result of the ListChallengeMetadata operation returned by the service.

See Also:

• AWS API Documentation

listChallengeMetadataPaginator

default ListChallengeMetadataIterable listChallengeMetadataPaginator(ListChallengeMetadataRequest listChallengeMetadataRequest)
                                                              throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

This is a variant of listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest) 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.pcaconnectorscep.paginators.ListChallengeMetadataIterable responses = client.listChallengeMetadataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataIterable responses = client
             .listChallengeMetadataPaginator(request);
     for (software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataIterable responses = client.listChallengeMetadataPaginator(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 listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest) operation.

Parameters:

listChallengeMetadataRequest -

Returns:

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

See Also:

• AWS API Documentation

listChallengeMetadataPaginator

default ListChallengeMetadataIterable listChallengeMetadataPaginator(Consumer<ListChallengeMetadataRequest.Builder> listChallengeMetadataRequest)
                                                              throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

This is a variant of listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest) 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.pcaconnectorscep.paginators.ListChallengeMetadataIterable responses = client.listChallengeMetadataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataIterable responses = client
             .listChallengeMetadataPaginator(request);
     for (software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataIterable responses = client.listChallengeMetadataPaginator(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 listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest) operation.

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

Parameters:

listChallengeMetadataRequest - A Consumer that will call methods on ListChallengeMetadataRequest.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

listConnectors

default ListConnectorsResponse listConnectors(ListConnectorsRequest listConnectorsRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Lists the connectors belonging to your Amazon Web Services account.

Parameters:

listConnectorsRequest -

Returns:

Result of the ListConnectors operation returned by the service.

See Also:

• AWS API Documentation

listConnectors

default ListConnectorsResponse listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Lists the connectors belonging to your Amazon Web Services account.

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

Parameters:

listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.

Returns:

Result of the ListConnectors operation returned by the service.

See Also:

• AWS API Documentation

listConnectorsPaginator

default ListConnectorsIterable listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)
                                                throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

This is a variant of listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest) 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.pcaconnectorscep.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsIterable responses = client
             .listConnectorsPaginator(request);
     for (software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(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 listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest) operation.

Parameters:

listConnectorsRequest -

Returns:

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

See Also:

• AWS API Documentation

listConnectorsPaginator

default ListConnectorsIterable listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
                                                throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

This is a variant of listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest) 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.pcaconnectorscep.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsIterable responses = client
             .listConnectorsPaginator(request);
     for (software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(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 listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest) operation.

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

Parameters:

listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.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 ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves the tags associated with the specified resource. Tags are key-value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a 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 ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Retrieves the tags associated with the specified resource. Tags are key-value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a 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

tagResource

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

Adds one or more tags to your 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 ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Adds one or more tags to your 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 ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Removes one or more tags from your 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 ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcaConnectorScepException

Removes one or more tags from your 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 PcaConnectorScepClient create()

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

builder

static PcaConnectorScepClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default PcaConnectorScepServiceClientConfiguration 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