DescribeListenerCertificates - Elastic Load Balancing

DescribeListenerCertificates

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).

For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ListenerArn

The Amazon Resource Names (ARN) of the listener.

Type: String

Required: Yes

Marker

The marker for the next set of results. (You received this marker from a previous call.)

Type: String

Required: No

PageSize

The maximum number of results to return with this call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 400.

Required: No

Response Elements

The following elements are returned by the service.

Certificates.member.N

Information about the certificates.

Type: Array of Certificate objects

NextMarker

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ListenerNotFound

The specified listener does not exist.

HTTP Status Code: 400

Examples

Describe the certificate list for a listener

This example describes the certificate list for the specified listener.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=DescribeListenerCertificates &ListenerArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 &Version=2015-12-01 &AUTHPARAMS

Sample Response

<DescribeListenerCertificatesResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/"> <DescribeListenerCertificatesResult> <Certificates> <member> <CertificateArn>arn:aws:acm:us-west-2:123456789012:certificate/1bf70a25-6914-495a-92f8-e27feEXAMPLE</CertificateArn> <IsDefault>true</IsDefault> </member> <member> <CertificateArn>arn:aws:acm:us-west-2:123456789012:certificate/68c11a12-39de-44dd-b329-fe64aEXAMPLE</CertificateArn> <IsDefault>false</IsDefault> </member> <member> <CertificateArn>arn:aws:acm:us-west-2:123456789012:certificate/1bf70a25-6914-495a-92f8-e27feEXAMPLE</CertificateArn> <IsDefault>false</IsDefault> </member> </Certificates> </DescribeListenerCertificatesResult> <ResponseMetadata> <RequestId>18e470d3-f39c-11e5-a53c-67205c0d10fd</RequestId> </ResponseMetadata> </DescribeListenerCertificatesResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: