Amazon API Gateway

{'certificateArn': 'string'}

Creates a new domain name.

See also: AWS API Documentation

Request Syntax

client.create_domain_name(
    domainName='string',
    certificateName='string',
    certificateBody='string',
    certificatePrivateKey='string',
    certificateChain='string',
    certificateArn='string'
)

type domainName:

string

param domainName:

[REQUIRED]

(Required) The name of the DomainName resource.

type certificateName:

string

param certificateName:

The user-friendly name of the certificate.

type certificateBody:

string

param certificateBody:

[Deprecated] The body of the server certificate provided by your certificate authority.

type certificatePrivateKey:

string

param certificatePrivateKey:

[Deprecated] Your certificate's private key.

type certificateChain:

string

param certificateChain:

[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

type certificateArn:

string

param certificateArn:

The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source.

rtype:

dict

returns:

Response Syntax

{
    'domainName': 'string',
    'certificateName': 'string',
    'certificateArn': 'string',
    'certificateUploadDate': datetime(2015, 1, 1),
    'distributionDomainName': 'string'
}

Response Structure

• (dict) --

  Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

  Use Client-Side Certificate

  • domainName (string) --

    The name of the DomainName resource.

  • certificateName (string) --

    The name of the certificate.

  • certificateArn (string) --

    The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source.

  • certificateUploadDate (datetime) --

    The timestamp when the certificate was uploaded.

  • distributionDomainName (string) --

    The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.

{'certificateArn': 'string'}

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

See also: AWS API Documentation

Request Syntax

client.get_domain_name(
    domainName='string'
)

type domainName:

string

param domainName:

[REQUIRED]

The name of the DomainName resource.

rtype:

dict

returns:

Response Syntax

{
    'domainName': 'string',
    'certificateName': 'string',
    'certificateArn': 'string',
    'certificateUploadDate': datetime(2015, 1, 1),
    'distributionDomainName': 'string'
}

Response Structure

• (dict) --

  Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

  Use Client-Side Certificate

  • domainName (string) --

    The name of the DomainName resource.

  • certificateName (string) --

    The name of the certificate.

  • certificateArn (string) --

    The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source.

  • certificateUploadDate (datetime) --

    The timestamp when the certificate was uploaded.

  • distributionDomainName (string) --

    The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.

{'items': {'certificateArn': 'string'}}

Represents a collection of DomainName resources.

See also: AWS API Documentation

Request Syntax

client.get_domain_names(
    position='string',
    limit=123
)

type position:

string

param position:

The position of the current domain names to get information about.

type limit:

integer

param limit:

The maximum number of DomainName resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.

rtype:

dict

returns:

Response Syntax

{
    'position': 'string',
    'items': [
        {
            'domainName': 'string',
            'certificateName': 'string',
            'certificateArn': 'string',
            'certificateUploadDate': datetime(2015, 1, 1),
            'distributionDomainName': 'string'
        },
    ]
}

Response Structure

• (dict) --

  Represents a collection of DomainName resources.

  Use Client-Side Certificate

  • position (string) --

  • items (list) --

    The current page of any DomainName resources in the collection of DomainName resources.

    • (dict) --

      Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

      Use Client-Side Certificate

      • domainName (string) --

        The name of the DomainName resource.

      • certificateName (string) --

        The name of the certificate.

      • certificateArn (string) --

        The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source.

      • certificateUploadDate (datetime) --

        The timestamp when the certificate was uploaded.

      • distributionDomainName (string) --

        The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.

{'certificateArn': 'string'}

Changes information about the DomainName resource.

See also: AWS API Documentation

Request Syntax

client.update_domain_name(
    domainName='string',
    patchOperations=[
        {
            'op': 'add'|'remove'|'replace'|'move'|'copy'|'test',
            'path': 'string',
            'value': 'string',
            'from': 'string'
        },
    ]
)

type domainName:

string

param domainName:

[REQUIRED]

The name of the DomainName resource to be changed.

type patchOperations:

list

param patchOperations:

A list of update operations to be applied to the specified resource and in the order specified in this list.

• (dict) -- A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.

  • op (string) --

    An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

  • path (string) --

    The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.

  • value (string) --

    The new target value of the update operation.

  • from (string) --

    Not supported.

rtype:

dict

returns:

Response Syntax

{
    'domainName': 'string',
    'certificateName': 'string',
    'certificateArn': 'string',
    'certificateUploadDate': datetime(2015, 1, 1),
    'distributionDomainName': 'string'
}

Response Structure

• (dict) --

  Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

  Use Client-Side Certificate

  • domainName (string) --

    The name of the DomainName resource.

  • certificateName (string) --

    The name of the certificate.

  • certificateArn (string) --

    The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source.

  • certificateUploadDate (datetime) --

    The timestamp when the certificate was uploaded.

  • distributionDomainName (string) --

    The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.