UpdateDomainName - Amazon API Gateway (original) (raw)
Changes information about the DomainName resource.
Request Syntax
PATCH /domainnames/domain_name?domainNameId=domainNameId HTTP/1.1
Content-type: application/json
{
"patchOperations": [
{
"from": "string",
"op": "string",
"path": "string",
"value": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
The name of the DomainName resource to be changed.
Required: Yes
The identifier for the domain name resource. Supported only for private custom domain names.
Request Body
The request accepts the following data in JSON format.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"certificateArn": "string",
"certificateName": "string",
"certificateUploadDate": number,
"distributionDomainName": "string",
"distributionHostedZoneId": "string",
"domainName": "string",
"domainNameArn": "string",
"domainNameId": "string",
"domainNameStatus": "string",
"domainNameStatusMessage": "string",
"endpointConfiguration": {
"ipAddressType": "string",
"types": [ "string" ],
"vpcEndpointIds": [ "string" ]
},
"managementPolicy": "string",
"mutualTlsAuthentication": {
"truststoreUri": "string",
"truststoreVersion": "string",
"truststoreWarnings": [ "string" ]
},
"ownershipVerificationCertificateArn": "string",
"policy": "string",
"regionalCertificateArn": "string",
"regionalCertificateName": "string",
"regionalDomainName": "string",
"regionalHostedZoneId": "string",
"routingMode": "string",
"securityPolicy": "string",
"tags": {
"string" : "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.
Type: String
The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
Type: String
The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
Type: Timestamp
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
Type: String
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
Type: String
The custom domain name as an API host name, for example, my-api.example.com.
Type: String
The ARN of the domain name.
Type: String
The identifier for the domain name resource. Supported only for private custom domain names.
Type: String
The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
Type: String
Valid Values: AVAILABLE | UPDATING | PENDING | PENDING_CERTIFICATE_REIMPORT | PENDING_OWNERSHIP_VERIFICATION
An optional text message containing detailed information about status of the DomainName migration.
Type: String
The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
Type: EndpointConfiguration object
A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.
Type: String
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
Type: MutualTlsAuthentication object
ownershipVerificationCertificateArn
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
Type: String
A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.
Type: String
The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
Type: String
The name of the certificate that will be used for validating the regional domain name.
Type: String
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
Type: String
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
Type: String
The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your APIs.
Type: String
Valid Values: BASE_PATH_MAPPING_ONLY | ROUTING_RULE_ONLY | ROUTING_RULE_THEN_BASE_PATH_MAPPING
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
Type: String
Valid Values: TLS_1_0 | TLS_1_2
The collection of tags. Each tag element is associated with a given resource.
Type: String to string map
Errors
For information about the errors that are common to all actions, see Common Errors.
BadRequestException
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400
ConflictException
The request configuration has conflicts. For details, see the accompanying error message.
HTTP Status Code: 409
LimitExceededException
The request exceeded the rate limit. Retry after the specified time period.
HTTP Status Code: 429
NotFoundException
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
TooManyRequestsException
The request has reached its throttling limit. Retry after the specified time period.
HTTP Status Code: 429
UnauthorizedException
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
Examples
Rotate the certificate name of an edge-optimized custom domain name
This example illustrates one usage of UpdateDomainName.
Sample Request
PATCH /domainnames/mon-api.com HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160615T214257Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160615/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}
{
"patchOperations" : [ {
"op" : "replace",
"path" : "/certificateName",
"value" : "mon-api.com-cert-rotated-today"
},{
"op" : "replace",
"path" : "/certificateArn",
"value" : "arn:aws:acm:us-east-1:012345678910:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a"
}]
}
Sample Response
{
"_links": {
"curies": [
{
"href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-basepathmapping-{rel}.html",
"name": "basepathmapping",
"templated": true
},
{
"href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-domainname-{rel}.html",
"name": "domainname",
"templated": true
}
],
"self": {
"href": "/domainnames/mon-api.com"
},
"basepathmapping:by-base-path": {
"href": "/domainnames/mon-api.com/basepathmappings/{base_path}",
"templated": true
},
"basepathmapping:create": {
"href": "/domainnames/mon-api.com/basepathmappings"
},
"domainname:basepathmappings": {
"href": "/domainnames/mon-api.com/basepathmappings{?limit}",
"templated": true
},
"domainname:delete": {
"href": "/domainnames/mon-api.com"
},
"domainname:update": {
"href": "/domainnames/mon-api.com"
}
},
"certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a",
"certificateName": "mon-api.com-cert-rotated-today",
"certificateUploadDate": "2016-06-15T21:14:43Z",
"distributionDomainName": "d2ck2x1vuc8qzh.cloudfront.net",
"domainName": "mon-api.com"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: