importCertificate method

Future<ImportCertificateResponse> importCertificate({
  1. required Uint8List certificate,
  2. required Uint8List privateKey,
  3. String? certificateArn,
  4. Uint8List? certificateChain,
  5. List<Tag>? tags,
})

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide. Note the following guidelines when importing third party certificates:

  • You must enter the private key that matches the certificate you are importing.
  • The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
  • If the certificate you are importing is not self-signed, you must enter its certificate chain.
  • If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.
  • The certificate, private key, and certificate chain must be PEM-encoded.
  • The current time must be between the Not Before and Not After certificate fields.
  • The Issuer field must not be empty.
  • The OCSP authority URL, if present, must not exceed 1000 characters.
  • To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certifica
  • When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by file://. For example, you can specify a certificate saved in the C:\temp folder as file://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.
  • When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
  • The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.

May throw ResourceNotFoundException. May throw LimitExceededException. May throw InvalidTagException. May throw TooManyTagsException. May throw TagPolicyException. May throw InvalidParameterException.

Parameter certificate : The certificate to import.

Parameter privateKey : The private key that matches the public key in the certificate.

Parameter certificateArn : The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.

Parameter certificateChain : The PEM encoded certificate chain.

Parameter tags : One or more resource tags to associate with the imported certificate.

Note: You cannot apply tags when reimporting a certificate.

Implementation

Future<ImportCertificateResponse> importCertificate({
  required Uint8List certificate,
  required Uint8List privateKey,
  String? certificateArn,
  Uint8List? certificateChain,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(certificate, 'certificate');
  ArgumentError.checkNotNull(privateKey, 'privateKey');
  _s.validateStringLength(
    'certificateArn',
    certificateArn,
    20,
    2048,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'CertificateManager.ImportCertificate'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Certificate': base64Encode(certificate),
      'PrivateKey': base64Encode(privateKey),
      if (certificateArn != null) 'CertificateArn': certificateArn,
      if (certificateChain != null)
        'CertificateChain': base64Encode(certificateChain),
      if (tags != null) 'Tags': tags,
    },
  );

  return ImportCertificateResponse.fromJson(jsonResponse.body);
}