com.amazonaws.services.pcaconnectorscep

Interface AWSPcaConnectorScep

All Known Subinterfaces:

AWSPcaConnectorScepAsync

All Known Implementing Classes:

AbstractAWSPcaConnectorScep, AbstractAWSPcaConnectorScepAsync, AWSPcaConnectorScepAsyncClient, AWSPcaConnectorScepClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSPcaConnectorScep

Interface for accessing Private CA Connector for SCEP.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSPcaConnectorScep instead.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateChallengeResult	createChallenge(CreateChallengeRequest createChallengeRequest) For general-purpose connectors.
CreateConnectorResult	createConnector(CreateConnectorRequest createConnectorRequest) Creates a SCEP connector.
DeleteChallengeResult	deleteChallenge(DeleteChallengeRequest deleteChallengeRequest) Deletes the specified Challenge.
DeleteConnectorResult	deleteConnector(DeleteConnectorRequest deleteConnectorRequest) Deletes the specified Connector.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetChallengeMetadataResult	getChallengeMetadata(GetChallengeMetadataRequest getChallengeMetadataRequest) Retrieves the metadata for the specified Challenge.
GetChallengePasswordResult	getChallengePassword(GetChallengePasswordRequest getChallengePasswordRequest) Retrieves the challenge password for the specified Challenge.
GetConnectorResult	getConnector(GetConnectorRequest getConnectorRequest) Retrieves details about the specified Connector.
ListChallengeMetadataResult	listChallengeMetadata(ListChallengeMetadataRequest listChallengeMetadataRequest) Retrieves the challenge metadata for the specified ARN.
ListConnectorsResult	listConnectors(ListConnectorsRequest listConnectorsRequest) Lists the connectors belonging to your Amazon Web Services account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the tags associated with the specified resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to your resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from your resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createChallenge

CreateChallengeResult createChallenge(CreateChallengeRequest createChallengeRequest)

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.

Throws:

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

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.

See Also:

AWS API Documentation

createConnector

CreateConnectorResult createConnector(CreateConnectorRequest createConnectorRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

deleteChallenge

DeleteChallengeResult deleteChallenge(DeleteChallengeRequest deleteChallengeRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

deleteConnector

DeleteConnectorResult deleteConnector(DeleteConnectorRequest deleteConnectorRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

getChallengeMetadata

GetChallengeMetadataResult getChallengeMetadata(GetChallengeMetadataRequest getChallengeMetadataRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

getChallengePassword

GetChallengePasswordResult getChallengePassword(GetChallengePasswordRequest getChallengePasswordRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

getConnector

GetConnectorResult getConnector(GetConnectorRequest getConnectorRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

listChallengeMetadata

ListChallengeMetadataResult listChallengeMetadata(ListChallengeMetadataRequest listChallengeMetadataRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

listConnectors

ListConnectorsResult listConnectors(ListConnectorsRequest listConnectorsRequest)

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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 than ACTIVE.

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.