PcaConnectorScepClient

Suggest an Edit

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.

Installation

NPM
npm install @aws-sdk/client-pca-connector-scep
Yarn
yarn add @aws-sdk/client-pca-connector-scep
pnpm
pnpm add @aws-sdk/client-pca-connector-scep

PcaConnectorScepClient Operations

Command
Summary
CreateChallengeCommand

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.

CreateConnectorCommand

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 .

DeleteChallengeCommand

Deletes the specified Challenge .

DeleteConnectorCommand

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

GetChallengeMetadataCommand

Retrieves the metadata for the specified Challenge .

GetChallengePasswordCommand

Retrieves the challenge password for the specified Challenge .

GetConnectorCommand

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.

ListChallengeMetadataCommand

Retrieves the challenge metadata for the specified ARN.

ListConnectorsCommand

Lists the connectors belonging to your Amazon Web Services account.

ListTagsForResourceCommand

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.

TagResourceCommand

Adds one or more tags to your resource.

UntagResourceCommand

Removes one or more tags from your resource.

PcaConnectorScepClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: PcaConnectorScepClientConfig