Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . lightsail ]

get-load-balancer-tls-certificates

Description

Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-load-balancer-tls-certificates
--load-balancer-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--load-balancer-name (string)

The name of the load balancer where you stored your TLS/SSL certificate.

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

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

See 'aws help' for descriptions of global parameters.

Output

tlsCertificates -> (list)

An array of LoadBalancerTlsCertificate objects describing your TLS/SSL certificates.

(structure)

Describes a load balancer TLS/SSL certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

name -> (string)

The name of the TLS/SSL certificate (e.g., my-certificate ).

arn -> (string)

The Amazon Resource Name (ARN) of the TLS/SSL certificate.

supportCode -> (string)

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or TLS/SSL certificate. This code enables our support team to look up your Lightsail information more easily.

createdAt -> (timestamp)

The time when you created your TLS/SSL certificate.

location -> (structure)

The AWS Region and Availability Zone where you created your certificate.

availabilityZone -> (string)

The Availability Zone. Follows the format us-east-2a (case-sensitive).

regionName -> (string)

The AWS Region name.

resourceType -> (string)

The resource type (e.g., LoadBalancerTlsCertificate .

loadBalancerName -> (string)

The load balancer name where your TLS/SSL certificate is attached.

isAttached -> (boolean)

When true , the TLS/SSL certificate is attached to the Lightsail load balancer.

status -> (string)

The status of the TLS/SSL certificate. Valid values are below.

domainName -> (string)

The domain name for your TLS/SSL certificate.

domainValidationRecords -> (list)

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

(structure)

Describes the validation record of each domain name in the TLS/SSL certificate.

name -> (string)

A fully qualified domain name in the certificate. For example, example.com .

type -> (string)

The type of validation record. For example, CNAME for domain validation.

value -> (string)

The value for that type.

validationStatus -> (string)

The validation status. Valid values are listed below.

domainName -> (string)

The domain name against which your TLS/SSL certificate was validated.

failureReason -> (string)

The reason for the TLS/SSL certificate validation failure.

issuedAt -> (timestamp)

The time when the TLS/SSL certificate was issued.

issuer -> (string)

The issuer of the certificate.

keyAlgorithm -> (string)

The algorithm that was used to generate the key pair (the public and private key).

notAfter -> (timestamp)

The timestamp when the TLS/SSL certificate expires.

notBefore -> (timestamp)

The timestamp when the TLS/SSL certificate is first valid.

renewalSummary -> (structure)

An object containing information about the status of Lightsail's managed renewal for the certificate.

renewalStatus -> (string)

The status of Lightsail's managed renewal of the certificate. Valid values are listed below.

domainValidationOptions -> (list)

Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.

(structure)

Contains information about the domain names on a TLS/SSL certificate that you will use to validate domain ownership.

domainName -> (string)

A fully qualified domain name in the certificate request.

validationStatus -> (string)

The status of the domain validation. Valid values are listed below.

revocationReason -> (string)

The reason the certificate was revoked. Valid values are below.

revokedAt -> (timestamp)

The timestamp when the TLS/SSL certificate was revoked.

serial -> (string)

The serial number of the certificate.

signatureAlgorithm -> (string)

The algorithm that was used to sign the certificate.

subject -> (string)

The name of the entity that is associated with the public key contained in the certificate.

subjectAlternativeNames -> (list)

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

(string)