AWS.PcaConnectorScep — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Note: 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.

Sending a Request Using PcaConnectorScep

var pcaconnectorscep = new AWS.PcaConnectorScep();
pcaconnectorscep.createChallenge(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the PcaConnectorScep object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var pcaconnectorscep = new AWS.PcaConnectorScep({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the pcaconnectorscep service identifier:

AWS.config.apiVersions = {
  pcaconnectorscep: '2018-05-10',
  // other service API versions
};

var pcaconnectorscep = new AWS.PcaConnectorScep();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.PcaConnectorScep(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createChallenge(params = {}, callback) ⇒ AWS.Request

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.

createConnector(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

deleteConnector(params = {}, callback) ⇒ AWS.Request

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

getChallengeMetadata(params = {}, callback) ⇒ AWS.Request

Retrieves the metadata for the specified Challenge.

getChallengePassword(params = {}, callback) ⇒ AWS.Request

Retrieves the challenge password for the specified Challenge.

getConnector(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Retrieves the challenge metadata for the specified ARN.

listConnectors(params = {}, callback) ⇒ AWS.Request

Lists the connectors belonging to your Amazon Web Services account.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Adds one or more tags to your resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from your resource.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given PcaConnectorScep resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.