Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . transfer ]

import-certificate

Description

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

You can import both the certificate and its chain in the Certificate parameter.

After importing a certificate, Transfer Family automatically creates a Amazon CloudWatch metric called DaysUntilExpiry that tracks the number of days until the certificate expires. The metric is based on the InactiveDate parameter and is published daily in the AWS/Transfer namespace.

Warning

It can take up to a full day after importing a certificate for Transfer Family to emit the DaysUntilExpiry metric to your account.

Note

If you use the Certificate parameter to upload both the certificate and its chain, don’t use the CertificateChain parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

• Units: Count (days)
• Dimensions: CertificateId (always present), Description (if provided during certificate import)
• Statistics: Minimum, Maximum, Average
• Frequency: Published daily

See also: AWS API Documentation

Synopsis

  import-certificate
--usage <value>
--certificate <value>
[--certificate-chain <value>]
[--private-key <value>]
[--active-date <value>]
[--inactive-date <value>]
[--description <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--usage (string)

Specifies how this certificate is used. It can be used in the following ways:

• SIGNING : For signing AS2 messages
• ENCRYPTION : For encrypting AS2 messages
• TLS : For securing AS2 communications sent over HTTPS

Possible values:

• SIGNING
• ENCRYPTION
• TLS

--certificate (string)

• For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem . Alternatively, you can provide the raw content.
• For the SDK, specify the raw content of a certificate file. For example, --certificate "`cat encryption-cert.pem`" .

Note

You can provide both the certificate and its chain in this parameter, without needing to use the CertificateChain parameter. If you use this parameter for both the certificate and its chain, do not use the CertificateChain parameter.

--certificate-chain (string)

An optional list of certificates that make up the chain for the certificate that’s being imported.

--private-key (string)

• For the CLI, provide a file path for a private key in URI format. For example, --private-key file://encryption-key.pem . Alternatively, you can provide the raw content of the private key file.
• For the SDK, specify the raw content of a private key file. For example, --private-key "`cat encryption-key.pem`"

--active-date (timestamp)

An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate , which is specified by the CA.

--inactive-date (timestamp)

An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate , which is specified by the CA.

--description (string)

A short description that helps identify the certificate.

--tags (list)

Key-value pairs that can be used to group and search for certificates.

(structure)

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

Key -> (string)

The name assigned to the tag that you create.

Value -> (string)

Contains one or more values that you assigned to the key name you create.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

CertificateId -> (string)

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.