# GenerateClientCertificate
<a name="API_GenerateClientCertificate"></a>

Generates a ClientCertificate resource.

## Request Syntax
<a name="API_GenerateClientCertificate_RequestSyntax"></a>

```
POST /clientcertificates HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_GenerateClientCertificate_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GenerateClientCertificate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_GenerateClientCertificate_RequestSyntax) **   <a name="apigw-GenerateClientCertificate-request-description"></a>
The description of the ClientCertificate.  
Type: String  
Required: No

 ** [tags](#API_GenerateClientCertificate_RequestSyntax) **   <a name="apigw-GenerateClientCertificate-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_GenerateClientCertificate_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "clientCertificateId": "string",
   "createdDate": number,
   "description": "string",
   "expirationDate": number,
   "pemEncodedCertificate": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GenerateClientCertificate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [clientCertificateId](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-clientCertificateId"></a>
The identifier of the client certificate.  
Type: String

 ** [createdDate](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-createdDate"></a>
The timestamp when the client certificate was created.  
Type: Timestamp

 ** [description](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-description"></a>
The description of the client certificate.  
Type: String

 ** [expirationDate](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-expirationDate"></a>
The timestamp when the client certificate will expire.  
Type: Timestamp

 ** [pemEncodedCertificate](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-pemEncodedCertificate"></a>
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .  
Type: String

 ** [tags](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

## Errors
<a name="API_GenerateClientCertificate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

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

 ** 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
<a name="API_GenerateClientCertificate_Examples"></a>

### Generate a client-side certificate
<a name="API_GenerateClientCertificate_Example_1"></a>

This example illustrates one usage of GenerateClientCertificate.

#### Sample Request
<a name="API_GenerateClientCertificate_Example_1_Request"></a>

```
POST /clientcertificates HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160615T223313Z
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}

{
    "description": "my-second-client-cert"
}
```

#### Sample Response
<a name="API_GenerateClientCertificate_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-clientcertificate-{rel}.html",
      "name": "clientcertificate",
      "templated": true
    },
    "self": {
      "href": "/clientcertificates/9ao60f"
    },
    "clientcertificate:delete": {
      "href": "/clientcertificates/9ao60f"
    },
    "clientcertificate:update": {
      "href": "/clientcertificates/9ao60f"
    }
  },
  "clientCertificateId": "9ao60f",
  "createdDate": "2016-06-15T22:33:13Z",
  "description": "my-second-client-cert",
  "expirationDate": "2017-06-15T22:33:13Z",
  "pemEncodedCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIC6T...2yQAGEHvs=\r\n-----END CERTIFICATE-----"
}
```

## See Also
<a name="API_GenerateClientCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GenerateClientCertificate)