@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSPcaConnectorScep
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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.
|
static final String ENDPOINT_PREFIX
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.
createChallengeRequest
- 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.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.
createConnectorRequest
- 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.DeleteChallengeResult deleteChallenge(DeleteChallengeRequest deleteChallengeRequest)
Deletes the specified Challenge.
deleteChallengeRequest
- 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.DeleteConnectorResult deleteConnector(DeleteConnectorRequest deleteConnectorRequest)
Deletes the specified Connector. This operation also deletes any challenges associated with the connector.
deleteConnectorRequest
- 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.GetChallengeMetadataResult getChallengeMetadata(GetChallengeMetadataRequest getChallengeMetadataRequest)
Retrieves the metadata for the specified Challenge.
getChallengeMetadataRequest
- 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.GetChallengePasswordResult getChallengePassword(GetChallengePasswordRequest getChallengePasswordRequest)
Retrieves the challenge password for the specified Challenge.
getChallengePasswordRequest
- 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.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.
getConnectorRequest
- 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.ListChallengeMetadataResult listChallengeMetadata(ListChallengeMetadataRequest listChallengeMetadataRequest)
Retrieves the challenge metadata for the specified ARN.
listChallengeMetadataRequest
- 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.ListConnectorsResult listConnectors(ListConnectorsRequest listConnectorsRequest)
Lists the connectors belonging to your Amazon Web Services account.
listConnectorsRequest
- 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.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.
listTagsForResourceRequest
- 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags to your resource.
tagResourceRequest
- 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from your resource.
untagResourceRequest
- 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.