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 staticbuilder()method.Connector for SCEP 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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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
CreateChallengeagain. We recommend frequently rotating your challenge passwords.- Parameters:
createChallengeRequest-- Returns:
- Result of the CreateChallenge operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.BadRequestException- The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.ConflictException- This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.ServiceQuotaExceededException- The request would cause a service quota to be exceeded.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
CreateChallengeagain. We recommend frequently rotating your challenge passwords.
This is a convenience which creates an instance of the
CreateChallengeRequest.Builderavoiding the need to create one manually viaCreateChallengeRequest.builder()- Parameters:
createChallengeRequest- AConsumerthat will call methods onCreateChallengeRequest.Builderto create a request.- Returns:
- Result of the CreateChallenge operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.BadRequestException- The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.ConflictException- This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.ServiceQuotaExceededException- The request would cause a service quota to be exceeded.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.ConflictException- This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.ServiceQuotaExceededException- The request would cause a service quota to be exceeded.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaCreateConnectorRequest.builder()- Parameters:
createConnectorRequest- AConsumerthat will call methods onCreateConnectorRequest.Builderto create a request.- Returns:
- Result of the CreateConnector operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.ConflictException- This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.ServiceQuotaExceededException- The request would cause a service quota to be exceeded.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.ConflictException- This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteChallengeRequest.builder()- Parameters:
deleteChallengeRequest- AConsumerthat will call methods onDeleteChallengeRequest.Builderto create a request.- Returns:
- Result of the DeleteChallenge operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.ConflictException- This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.ConflictException- This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteConnectorRequest.builder()- Parameters:
deleteConnectorRequest- AConsumerthat will call methods onDeleteConnectorRequest.Builderto create a request.- Returns:
- Result of the DeleteConnector operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.ConflictException- This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetChallengeMetadataRequest.builder()- Parameters:
getChallengeMetadataRequest- AConsumerthat will call methods onGetChallengeMetadataRequest.Builderto create a request.- Returns:
- Result of the GetChallengeMetadata operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetChallengePasswordRequest.builder()- Parameters:
getChallengePasswordRequest- AConsumerthat will call methods onGetChallengePasswordRequest.Builderto create a request.- Returns:
- Result of the GetChallengePassword operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetConnectorRequest.builder()- Parameters:
getConnectorRequest- AConsumerthat will call methods onGetConnectorRequest.Builderto create a request.- Returns:
- Result of the GetConnector operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListChallengeMetadataRequest.builder()- Parameters:
listChallengeMetadataRequest- AConsumerthat will call methods onListChallengeMetadataRequest.Builderto create a request.- Returns:
- Result of the ListChallengeMetadata operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataIterable responses = client.listChallengeMetadataPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataIterable responses = client.listChallengeMetadataPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListChallengeMetadataRequest.builder()- Parameters:
listChallengeMetadataRequest- AConsumerthat will call methods onListChallengeMetadataRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListConnectorsRequest.builder()- Parameters:
listConnectorsRequest- AConsumerthat will call methods onListConnectorsRequest.Builderto create a request.- Returns:
- Result of the ListConnectors operation returned by the service.
- Throws:
InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListConnectorsRequest.builder()- Parameters:
listConnectorsRequest- AConsumerthat will call methods onListConnectorsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- 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 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- 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 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- 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 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- 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 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- 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 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.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- 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 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other thanACTIVE.InternalServerException- The request processing has failed because of an unknown error, exception or failure with an internal server.ValidationException- An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.ThrottlingException- The limit on the number of requests per second was exceeded.AccessDeniedException- You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.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.PcaConnectorScepException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static PcaConnectorScepClient create()
Create aPcaConnectorScepClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static PcaConnectorScepClientBuilder builder()
Create a builder that can be used to configure and create aPcaConnectorScepClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default PcaConnectorScepServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-