pcaconnectorscep/aws.sdk.kotlin.services.pcaconnectorscep

Package-level declarations

Types

interface PcaConnectorScepClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createChallenge

inline suspend fun PcaConnectorScepClient.createChallenge(crossinline block: CreateChallengeRequest.Builder.() -> Unit): CreateChallengeResponse

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.

createConnector

inline suspend fun PcaConnectorScepClient.createConnector(crossinline block: CreateConnectorRequest.Builder.() -> Unit): CreateConnectorResponse

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.

deleteChallenge

inline suspend fun PcaConnectorScepClient.deleteChallenge(crossinline block: DeleteChallengeRequest.Builder.() -> Unit): DeleteChallengeResponse

Deletes the specified Challenge.

deleteConnector

inline suspend fun PcaConnectorScepClient.deleteConnector(crossinline block: DeleteConnectorRequest.Builder.() -> Unit): DeleteConnectorResponse

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

getChallengeMetadata

inline suspend fun PcaConnectorScepClient.getChallengeMetadata(crossinline block: GetChallengeMetadataRequest.Builder.() -> Unit): GetChallengeMetadataResponse

Retrieves the metadata for the specified Challenge.

getChallengePassword

inline suspend fun PcaConnectorScepClient.getChallengePassword(crossinline block: GetChallengePasswordRequest.Builder.() -> Unit): GetChallengePasswordResponse

Retrieves the challenge password for the specified Challenge.

getConnector

inline suspend fun PcaConnectorScepClient.getConnector(crossinline block: GetConnectorRequest.Builder.() -> Unit): GetConnectorResponse

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.

listChallengeMetadata

inline suspend fun PcaConnectorScepClient.listChallengeMetadata(crossinline block: ListChallengeMetadataRequest.Builder.() -> Unit): ListChallengeMetadataResponse

Retrieves the challenge metadata for the specified ARN.

listConnectors

inline suspend fun PcaConnectorScepClient.listConnectors(crossinline block: ListConnectorsRequest.Builder.() -> Unit): ListConnectorsResponse

Lists the connectors belonging to your Amazon Web Services account.

listTagsForResource

inline suspend fun PcaConnectorScepClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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.

tagResource

inline suspend fun PcaConnectorScepClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds one or more tags to your resource.

untagResource

inline suspend fun PcaConnectorScepClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from your resource.

withConfig

fun PcaConnectorScepClient.withConfig(block: PcaConnectorScepClient.Config.Builder.() -> Unit): PcaConnectorScepClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.