@datafire/amazonaws_acm
v5.0.0
Published
DataFire integration for AWS Certificate Manager
Downloads
5
Readme
@datafire/amazonaws_acm
Client library for AWS Certificate Manager
Installation and Usage
npm install --save @datafire/amazonaws_acm
let amazonaws_acm = require('@datafire/amazonaws_acm').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_acm.AddTagsToCertificate({
"CertificateArn": "",
"Tags": []
}).then(data => {
console.log(data);
});
Description
AWS Certificate Manager Welcome to the AWS Certificate Manager (ACM) API documentation. You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the AWS Certificate Manager User Guide .
Actions
AddTagsToCertificate
amazonaws_acm.AddTagsToCertificate({
"CertificateArn": "",
"Tags": []
}, context)
Input
Output
Output schema unknown
DeleteCertificate
amazonaws_acm.DeleteCertificate({
"CertificateArn": ""
}, context)
Input
- input
object
- CertificateArn required Arn
Output
Output schema unknown
DescribeCertificate
amazonaws_acm.DescribeCertificate({
"CertificateArn": ""
}, context)
Input
- input
object
- CertificateArn required Arn
Output
- output DescribeCertificateResponse
GetCertificate
amazonaws_acm.GetCertificate({
"CertificateArn": ""
}, context)
Input
- input
object
- CertificateArn required Arn
Output
- output GetCertificateResponse
ImportCertificate
amazonaws_acm.ImportCertificate({
"Certificate": "",
"PrivateKey": ""
}, context)
Input
- input
object
- Certificate required CertificateBodyBlob
- CertificateArn Arn
- CertificateChain CertificateChainBlob
- PrivateKey required PrivateKeyBlob
Output
- output ImportCertificateResponse
ListCertificates
amazonaws_acm.ListCertificates({}, context)
Input
- input
object
- MaxItems
string
- NextToken
string
- CertificateStatuses CertificateStatuses
- Includes Filters
- MaxItems MaxItems
- NextToken NextToken
- MaxItems
Output
- output ListCertificatesResponse
ListTagsForCertificate
amazonaws_acm.ListTagsForCertificate({
"CertificateArn": ""
}, context)
Input
- input
object
- CertificateArn required Arn
Output
RemoveTagsFromCertificate
amazonaws_acm.RemoveTagsFromCertificate({
"CertificateArn": "",
"Tags": []
}, context)
Input
Output
Output schema unknown
RequestCertificate
amazonaws_acm.RequestCertificate({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainNameString
- DomainValidationOptions DomainValidationOptionList
- IdempotencyToken IdempotencyToken
- SubjectAlternativeNames DomainList
- ValidationMethod ValidationMethod
Output
- output RequestCertificateResponse
ResendValidationEmail
amazonaws_acm.ResendValidationEmail({
"CertificateArn": "",
"Domain": "",
"ValidationDomain": ""
}, context)
Input
- input
object
- CertificateArn required Arn
- Domain required DomainNameString
- ValidationDomain required DomainNameString
Output
Output schema unknown
Definitions
AddTagsToCertificateRequest
Arn
- Arn
string
CertificateBody
- CertificateBody
string
CertificateBodyBlob
- CertificateBodyBlob
string
CertificateChain
- CertificateChain
string
CertificateChainBlob
- CertificateChainBlob
string
CertificateDetail
- CertificateDetail
object
: Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.- CertificateArn Arn
- CreatedAt TStamp
- DomainName DomainNameString
- DomainValidationOptions DomainValidationList
- ExtendedKeyUsages ExtendedKeyUsageList
- FailureReason FailureReason
- ImportedAt TStamp
- InUseBy InUseList
- IssuedAt TStamp
- Issuer String
- KeyAlgorithm KeyAlgorithm
- KeyUsages KeyUsageList
- NotAfter TStamp
- NotBefore TStamp
- RenewalSummary RenewalSummary
- RevocationReason RevocationReason
- RevokedAt TStamp
- Serial String
- SignatureAlgorithm String
- Status CertificateStatus
- Subject String
- SubjectAlternativeNames DomainList
- Type CertificateType
CertificateStatus
- CertificateStatus
string
(values: PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, VALIDATION_TIMED_OUT, REVOKED, FAILED)
CertificateStatuses
- CertificateStatuses
array
- items CertificateStatus
CertificateSummary
- CertificateSummary
object
: This structure is returned in the response object of ListCertificates action.- CertificateArn Arn
- DomainName DomainNameString
CertificateSummaryList
- CertificateSummaryList
array
- items CertificateSummary
CertificateType
- CertificateType
string
(values: IMPORTED, AMAZON_ISSUED)
DeleteCertificateRequest
- DeleteCertificateRequest
object
- CertificateArn required Arn
DescribeCertificateRequest
- DescribeCertificateRequest
object
- CertificateArn required Arn
DescribeCertificateResponse
- DescribeCertificateResponse
object
- Certificate CertificateDetail
DomainList
- DomainList
array
- items DomainNameString
DomainNameString
- DomainNameString
string
DomainStatus
- DomainStatus
string
(values: PENDING_VALIDATION, SUCCESS, FAILED)
DomainValidation
- DomainValidation
object
: Contains information about the validation of each domain name in the certificate.- DomainName required DomainNameString
- ResourceRecord ResourceRecord
- ValidationDomain DomainNameString
- ValidationEmails ValidationEmailList
- ValidationMethod ValidationMethod
- ValidationStatus DomainStatus
DomainValidationList
- DomainValidationList
array
- items DomainValidation
DomainValidationOption
- DomainValidationOption
object
: Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.- DomainName required DomainNameString
- ValidationDomain required DomainNameString
DomainValidationOptionList
- DomainValidationOptionList
array
- items DomainValidationOption
ExtendedKeyUsage
- ExtendedKeyUsage
object
: The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.- Name ExtendedKeyUsageName
- OID String
ExtendedKeyUsageFilterList
- ExtendedKeyUsageFilterList
array
- items ExtendedKeyUsageName
ExtendedKeyUsageList
- ExtendedKeyUsageList
array
- items ExtendedKeyUsage
ExtendedKeyUsageName
- ExtendedKeyUsageName
string
(values: TLS_WEB_SERVER_AUTHENTICATION, TLS_WEB_CLIENT_AUTHENTICATION, CODE_SIGNING, EMAIL_PROTECTION, TIME_STAMPING, OCSP_SIGNING, IPSEC_END_SYSTEM, IPSEC_TUNNEL, IPSEC_USER, ANY, NONE, CUSTOM)
FailureReason
- FailureReason
string
(values: NO_AVAILABLE_CONTACTS, ADDITIONAL_VERIFICATION_REQUIRED, DOMAIN_NOT_ALLOWED, INVALID_PUBLIC_DOMAIN, CAA_ERROR, OTHER)
Filters
- Filters
object
: This structure can be used in the ListCertificates action to filter the output of the certificate list.- extendedKeyUsage ExtendedKeyUsageFilterList
- keyTypes KeyAlgorithmList
- keyUsage KeyUsageFilterList
GetCertificateRequest
- GetCertificateRequest
object
- CertificateArn required Arn
GetCertificateResponse
- GetCertificateResponse
object
- Certificate CertificateBody
- CertificateChain CertificateChain
IdempotencyToken
- IdempotencyToken
string
ImportCertificateRequest
- ImportCertificateRequest
object
- Certificate required CertificateBodyBlob
- CertificateArn Arn
- CertificateChain CertificateChainBlob
- PrivateKey required PrivateKeyBlob
ImportCertificateResponse
- ImportCertificateResponse
object
- CertificateArn Arn
InUseList
- InUseList
array
- items String
InvalidArnException
- InvalidArnException
object
: The requested Amazon Resource Name (ARN) does not refer to an existing resource.- message String
InvalidDomainValidationOptionsException
- InvalidDomainValidationOptionsException
object
: One or more values in the DomainValidationOption structure is incorrect.- message String
InvalidStateException
- InvalidStateException
object
: Processing has reached an invalid state. For example, this exception can occur if the specified domain is not using email validation, or the current certificate status does not permit the requested operation. See the exception message returned by ACM to determine which state is not valid.- message String
InvalidTagException
- InvalidTagException
object
: One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.- message String
KeyAlgorithm
- KeyAlgorithm
string
(values: RSA_2048, RSA_1024, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1)
KeyAlgorithmList
- KeyAlgorithmList
array
- items KeyAlgorithm
KeyUsage
- KeyUsage
object
: The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.- Name KeyUsageName
KeyUsageFilterList
- KeyUsageFilterList
array
- items KeyUsageName
KeyUsageList
- KeyUsageList
array
- items KeyUsage
KeyUsageName
- KeyUsageName
string
(values: DIGITAL_SIGNATURE, NON_REPUDIATION, KEY_ENCIPHERMENT, DATA_ENCIPHERMENT, KEY_AGREEMENT, CERTIFICATE_SIGNING, CRL_SIGNING, ENCIPHER_ONLY, DECIPHER_ONLY, ANY, CUSTOM)
LimitExceededException
- LimitExceededException
object
: An ACM limit has been exceeded. For example, you may have input more domains than are allowed or you've requested too many certificates for your account. See the exception message returned by ACM to determine which limit you have violated. For more information about ACM limits, see the Limits topic.- message String
ListCertificatesRequest
- ListCertificatesRequest
object
- CertificateStatuses CertificateStatuses
- Includes Filters
- MaxItems MaxItems
- NextToken NextToken
ListCertificatesResponse
- ListCertificatesResponse
object
- CertificateSummaryList CertificateSummaryList
- NextToken NextToken
ListTagsForCertificateRequest
- ListTagsForCertificateRequest
object
- CertificateArn required Arn
ListTagsForCertificateResponse
- ListTagsForCertificateResponse
object
- Tags TagList
MaxItems
- MaxItems
integer
NextToken
- NextToken
string
PrivateKeyBlob
- PrivateKeyBlob
string
RecordType
- RecordType
string
(values: CNAME)
RemoveTagsFromCertificateRequest
RenewalStatus
- RenewalStatus
string
(values: PENDING_AUTO_RENEWAL, PENDING_VALIDATION, SUCCESS, FAILED)
RenewalSummary
- RenewalSummary
object
: Contains information about the status of ACM's managed renewal for the certificate. This structure exists only when the certificate type is AMAZON_ISSUED.- DomainValidationOptions required DomainValidationList
- RenewalStatus required RenewalStatus
RequestCertificateRequest
- RequestCertificateRequest
object
- DomainName required DomainNameString
- DomainValidationOptions DomainValidationOptionList
- IdempotencyToken IdempotencyToken
- SubjectAlternativeNames DomainList
- ValidationMethod ValidationMethod
RequestCertificateResponse
- RequestCertificateResponse
object
- CertificateArn Arn
RequestInProgressException
- RequestInProgressException
object
: The certificate request is in process and the certificate in your account has not yet been issued.- message String
ResendValidationEmailRequest
- ResendValidationEmailRequest
object
- CertificateArn required Arn
- Domain required DomainNameString
- ValidationDomain required DomainNameString
ResourceInUseException
- ResourceInUseException
object
: The certificate is in use by another AWS service in the caller's account. Remove the association and try again.- message String
ResourceNotFoundException
- ResourceNotFoundException
object
: The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.- message String
ResourceRecord
- ResourceRecord
object
: Contains a DNS record value that you can use to can use to validate ownership or control of a domain. This is used by the DescribeCertificate action.- Name required String
- Type required RecordType
- Value required String
RevocationReason
- RevocationReason
string
(values: UNSPECIFIED, KEY_COMPROMISE, CA_COMPROMISE, AFFILIATION_CHANGED, SUPERCEDED, CESSATION_OF_OPERATION, CERTIFICATE_HOLD, REMOVE_FROM_CRL, PRIVILEGE_WITHDRAWN, A_A_COMPROMISE)
String
- String
string
TStamp
- TStamp
string
Tag
- Tag
object
: A key-value pair that identifies or specifies metadata about an ACM resource.
TagKey
- TagKey
string
TagList
- TagList
array
- items Tag
TagValue
- TagValue
string
TooManyTagsException
- TooManyTagsException
object
: The request contains too many tags. Try the request again with fewer tags.- message String
ValidationEmailList
- ValidationEmailList
array
- items String
ValidationMethod
- ValidationMethod
string
(values: EMAIL, DNS)