RTBFabric / Client / associate_certificate

associate_certificate

RTBFabric.Client.associate_certificate(**kwargs)

Associates an ACM certificate with a responder gateway.

See also: AWS API Documentation

Request Syntax

response = client.associate_certificate(
    gatewayId='string',
    acmCertificateArn='string',
    clientToken='string'
)
Parameters:

  • gatewayId (string) –

    [REQUIRED]

    The unique identifier of the gateway.

  • acmCertificateArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the ACM certificate to associate.

  • clientToken (string) –

    [REQUIRED]

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don’t provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayId': 'string',
    'acmCertificateArn': 'string',
    'status': 'PENDING_ASSOCIATION'|'ASSOCIATED'|'PENDING_DISASSOCIATION'|'DISASSOCIATED'|'FAILED'
}

Response Structure

  • (dict) –

    • gatewayId (string) –

      The unique identifier of the gateway.

    • acmCertificateArn (string) –

      The Amazon Resource Name (ARN) of the ACM certificate.

    • status (string) –

      The status of the certificate association.

Exceptions