# Stages
<a name="apis-apiid-stages"></a>

Represents the collection of stages for an API.

## URI
<a name="apis-apiid-stages-url"></a>

`/v2/apis/apiId/stages`

## HTTP methods
<a name="apis-apiid-stages-http-methods"></a>

### GET
<a name="apis-apiid-stagesget"></a>

**Operation ID:** `GetStages`

Gets the `Stages` for an API.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| apiId | String | True | The API identifier. | 


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The next page of elements from this collection. Not valid for the last element of the collection. | 
| maxResults | String | False | The maximum number of elements to be returned for this resource. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | Stages | Success | 
| 400 | BadRequestException | One of the parameters in the request is invalid. | 
| 404 | NotFoundException | The resource specified in the request was not found. | 
| 429 | LimitExceededException | The client is sending more than the allowed number of requests per unit of time. | 

### POST
<a name="apis-apiid-stagespost"></a>

**Operation ID:** `CreateStage`

Creates a `Stage` for an API.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| apiId | String | True | The API identifier. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | Stage | The request has succeeded and has resulted in the creation of a resource. | 
| 400 | BadRequestException | One of the parameters in the request is invalid. | 
| 404 | NotFoundException | The resource specified in the request was not found. | 
| 409 | ConflictException | The resource already exists. | 
| 429 | LimitExceededException | The client is sending more than the allowed number of requests per unit of time. | 

## Schemas
<a name="apis-apiid-stages-schemas"></a>

### Request bodies
<a name="apis-apiid-stages-request-examples"></a>

#### POST schema
<a name="apis-apiid-stages-request-body-post-example"></a>

```
{
  "stageName": "string",
  "description": "string",
  "deploymentId": "string",
  "clientCertificateId": "string",
  "defaultRouteSettings": {
    "detailedMetricsEnabled": boolean,
    "loggingLevel": enum,
    "dataTraceEnabled": boolean,
    "throttlingBurstLimit": integer,
    "throttlingRateLimit": number
  },
  "routeSettings": {
  },
  "stageVariables": {
  },
  "accessLogSettings": {
    "format": "string",
    "destinationArn": "string"
  },
  "tags": {
  },
  "autoDeploy": boolean
}
```

### Response bodies
<a name="apis-apiid-stages-response-examples"></a>

#### Stages schema
<a name="apis-apiid-stages-response-body-stages-example"></a>

```
{
  "items": [
    {
      "stageName": "string",
      "description": "string",
      "deploymentId": "string",
      "clientCertificateId": "string",
      "defaultRouteSettings": {
        "detailedMetricsEnabled": boolean,
        "loggingLevel": enum,
        "dataTraceEnabled": boolean,
        "throttlingBurstLimit": integer,
        "throttlingRateLimit": number
      },
      "routeSettings": {
      },
      "stageVariables": {
      },
      "accessLogSettings": {
        "format": "string",
        "destinationArn": "string"
      },
      "autoDeploy": boolean,
      "lastDeploymentStatusMessage": "string",
      "createdDate": "string",
      "lastUpdatedDate": "string",
      "tags": {
      },
      "apiGatewayManaged": boolean
    }
  ],
  "nextToken": "string"
}
```

#### Stage schema
<a name="apis-apiid-stages-response-body-stage-example"></a>

```
{
  "stageName": "string",
  "description": "string",
  "deploymentId": "string",
  "clientCertificateId": "string",
  "defaultRouteSettings": {
    "detailedMetricsEnabled": boolean,
    "loggingLevel": enum,
    "dataTraceEnabled": boolean,
    "throttlingBurstLimit": integer,
    "throttlingRateLimit": number
  },
  "routeSettings": {
  },
  "stageVariables": {
  },
  "accessLogSettings": {
    "format": "string",
    "destinationArn": "string"
  },
  "autoDeploy": boolean,
  "lastDeploymentStatusMessage": "string",
  "createdDate": "string",
  "lastUpdatedDate": "string",
  "tags": {
  },
  "apiGatewayManaged": boolean
}
```

#### BadRequestException schema
<a name="apis-apiid-stages-response-body-badrequestexception-example"></a>

```
{
  "message": "string"
}
```

#### NotFoundException schema
<a name="apis-apiid-stages-response-body-notfoundexception-example"></a>

```
{
  "message": "string",
  "resourceType": "string"
}
```

#### ConflictException schema
<a name="apis-apiid-stages-response-body-conflictexception-example"></a>

```
{
  "message": "string"
}
```

#### LimitExceededException schema
<a name="apis-apiid-stages-response-body-limitexceededexception-example"></a>

```
{
  "message": "string",
  "limitType": "string"
}
```

## Properties
<a name="apis-apiid-stages-properties"></a>

### AccessLogSettings
<a name="apis-apiid-stages-model-accesslogsettings"></a>

Settings for logging access in a stage.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destinationArn | string | False | The ARN of the CloudWatch Logs log group to receive access logs. | 
| format | string | False | A single line format of the access logs of data, as specified by selected \$1context variables. The format must include at least \$1context.requestId. | 

### BadRequestException
<a name="apis-apiid-stages-model-badrequestexception"></a>

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Describes the error encountered. | 

### ConflictException
<a name="apis-apiid-stages-model-conflictexception"></a>

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Describes the error encountered. | 

### CreateStageInput
<a name="apis-apiid-stages-model-createstageinput"></a>

Represents the input parameters for a `CreateStage` request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| accessLogSettings | [AccessLogSettings](#apis-apiid-stages-model-accesslogsettings) | False | Settings for logging access in this stage. | 
| autoDeploy | boolean | False | Specifies whether updates to an API automatically trigger a new deployment. The default value is `false`. | 
| clientCertificateId | string | False | The identifier of a client certificate for a `Stage`. Supported only for WebSocket APIs. | 
| defaultRouteSettings | [RouteSettings](#apis-apiid-stages-model-routesettings) | False | The default route settings for the stage. | 
| deploymentId | string | False | The deployment identifier of the API stage. | 
| description | string | False | The description for the API stage. | 
| routeSettings | [RouteSettingsMap](#apis-apiid-stages-model-routesettingsmap) | False | Route settings for the stage, by `routeKey`. | 
| stageName | string | True | The name of the stage. | 
| stageVariables | [StageVariablesMap](#apis-apiid-stages-model-stagevariablesmap) | False | A map that defines the stage variables for a `Stage`. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-.\$1\$1:/?\$1&=,]\$1. | 
| tags | [Tags](#apis-apiid-stages-model-tags) | False | The collection of tags. Each tag element is associated with a given resource. | 

### LimitExceededException
<a name="apis-apiid-stages-model-limitexceededexception"></a>

A limit has been exceeded. See the accompanying error message for details.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| limitType | string | False | The limit type. | 
| message | string | False | Describes the error encountered. | 

### LoggingLevel
<a name="apis-apiid-stages-model-logginglevel"></a>

The logging level.
+ `ERROR`
+ `INFO`
+ `false`

### NotFoundException
<a name="apis-apiid-stages-model-notfoundexception"></a>

The resource specified in the request was not found. See the `message` field for more information.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Describes the error encountered. | 
| resourceType | string | False | The resource type. | 

### RouteSettings
<a name="apis-apiid-stages-model-routesettings"></a>

Represents a collection of route settings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| dataTraceEnabled | boolean | False | Specifies whether (`true`) or not (`false`) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs. | 
| detailedMetricsEnabled | boolean | False | Specifies whether detailed metrics are enabled. | 
| loggingLevel | [LoggingLevel](#apis-apiid-stages-model-logginglevel) | False | Specifies the logging level for this route: `INFO`, `ERROR`, or `OFF`. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs. | 
| throttlingBurstLimit | integerFormat: int32 | False | Specifies the throttling burst limit. | 
| throttlingRateLimit | numberFormat: double | False | Specifies the throttling rate limit. | 

### RouteSettingsMap
<a name="apis-apiid-stages-model-routesettingsmap"></a>

The route settings map.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | object | False |  | 

### Stage
<a name="apis-apiid-stages-model-stage"></a>

Represents an API stage.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| accessLogSettings | [AccessLogSettings](#apis-apiid-stages-model-accesslogsettings) | False | Settings for logging access in this stage. | 
| apiGatewayManaged | boolean | False | Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the `$default` stage is managed by API Gateway. You can't modify the `$default` stage. | 
| autoDeploy | boolean | False | Specifies whether updates to an API automatically trigger a new deployment. The default value is `false`. | 
| clientCertificateId | string | False | The identifier of a client certificate for a `Stage`. Supported only for WebSocket APIs. | 
| createdDate | stringFormat: date-time | False | The timestamp when the stage was created. | 
| defaultRouteSettings | [RouteSettings](#apis-apiid-stages-model-routesettings) | False | Default route settings for the stage. | 
| deploymentId | string | False | The identifier of the `Deployment` that the `Stage` is associated with. Can't be updated if `autoDeploy` is enabled. | 
| description | string | False | The description of the stage. | 
| lastDeploymentStatusMessage | string | False | Describes the status of the last deployment of a stage. Supported only for stages with `autoDeploy` enabled. | 
| lastUpdatedDate | stringFormat: date-time | False | The timestamp when the stage was last updated. | 
| routeSettings | [RouteSettingsMap](#apis-apiid-stages-model-routesettingsmap) | False | Route settings for the stage, by `routeKey`. | 
| stageName | string | True | The name of the stage. | 
| stageVariables | [StageVariablesMap](#apis-apiid-stages-model-stagevariablesmap) | False | A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-.\$1\$1:/?\$1&=,]\$1. | 
| tags | [Tags](#apis-apiid-stages-model-tags) | False | The collection of tags. Each tag element is associated with a given resource. | 

### StageVariablesMap
<a name="apis-apiid-stages-model-stagevariablesmap"></a>

The stage variable map.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### Stages
<a name="apis-apiid-stages-model-stages"></a>

A collection of Stage resources that are associated with the ApiKey resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| items | Array of type [Stage](#apis-apiid-stages-model-stage) | False | The elements from this collection. | 
| nextToken | string | False | The next page of elements from this collection. Not valid for the last element of the collection. | 

### Tags
<a name="apis-apiid-stages-model-tags"></a>

Represents a collection of tags associated with the resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="apis-apiid-stages-see-also"></a>

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

### GetStages
<a name="GetStages-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/apigatewayv2-2018-11-29/GetStages)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/apigatewayv2-2018-11-29/GetStages)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/apigatewayv2-2018-11-29/GetStages)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/apigatewayv2-2018-11-29/GetStages)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/apigatewayv2-2018-11-29/GetStages)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/apigatewayv2-2018-11-29/GetStages)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/apigatewayv2-2018-11-29/GetStages)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/apigatewayv2-2018-11-29/GetStages)
+ [AWS SDK for Python](/goto/boto3/apigatewayv2-2018-11-29/GetStages)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/apigatewayv2-2018-11-29/GetStages)

### CreateStage
<a name="CreateStage-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/apigatewayv2-2018-11-29/CreateStage)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/apigatewayv2-2018-11-29/CreateStage)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/apigatewayv2-2018-11-29/CreateStage)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/apigatewayv2-2018-11-29/CreateStage)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/apigatewayv2-2018-11-29/CreateStage)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/apigatewayv2-2018-11-29/CreateStage)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/apigatewayv2-2018-11-29/CreateStage)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/apigatewayv2-2018-11-29/CreateStage)
+ [AWS SDK for Python](/goto/boto3/apigatewayv2-2018-11-29/CreateStage)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/apigatewayv2-2018-11-29/CreateStage)