# GetDeployments
<a name="API_GetDeployments"></a>

Gets information about a Deployments collection.

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

```
GET /restapis/restapi_id/deployments?limit=limit&position=position HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [limit](#API_GetDeployments_RequestSyntax) **   <a name="apigw-GetDeployments-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetDeployments_RequestSyntax) **   <a name="apigw-GetDeployments-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [restapi\$1id](#API_GetDeployments_RequestSyntax) **   <a name="apigw-GetDeployments-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

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

The request does not have a request body.

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

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

{
   "item": [ 
      { 
         "apiSummary": { 
            "string" : { 
               "string" : { 
                  "apiKeyRequired": boolean,
                  "authorizationType": "string"
               }
            }
         },
         "createdDate": number,
         "description": "string",
         "id": "string"
      }
   ],
   "position": "string"
}
```

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

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

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

 ** [item](#API_GetDeployments_ResponseSyntax) **   <a name="apigw-GetDeployments-response-item"></a>
The current page of elements from this collection.  
Type: Array of [Deployment](API_Deployment.md) objects

 ** [position](#API_GetDeployments_ResponseSyntax) **   <a name="apigw-GetDeployments-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetDeployments_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

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.  
HTTP Status Code: 503

 ** 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_GetDeployments_Examples"></a>

### Get the deployments of an API
<a name="API_GetDeployments_Example_1"></a>

This example illustrates one usage of GetDeployments.

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

```
GET /restapis/fugvjdxtri/deployments?limit=2 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160606T222635Z
Authorization: AWS4-HMAC-SHA256 Credential={secrete_key}/20160606/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
```

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

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
      "name": "deployment",
      "templated": true
    },
    "self": {
      "href": "/restapis/fugvjdxtri/deployments?limit=2"
    },
    "deployment:by-id": {
      "href": "/restapis/fugvjdxtri/deployments/{deployment_id}{?embed}",
      "templated": true
    },
    "deployment:create": {
      "href": "/restapis/fugvjdxtri/deployments"
    },
    "item": [
      {
        "href": "/restapis/fugvjdxtri/deployments/4vvti6"
      },
      {
        "href": "/restapis/fugvjdxtri/deployments/a9kdln"
      }
    ],
    "next": {
      "href": "/restapis/fugvjdxtri/deployments?position=aWQ9U2E5a2Rsbg%3D%3D&limit=2"
    }
  },
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/restapis/fugvjdxtri/deployments/4vvti6"
          },
          "deployment:delete": {
            "href": "/restapis/fugvjdxtri/deployments/4vvti6"
          },
          "deployment:stages": {
            "href": "/restapis/fugvjdxtri/stages?deployment_id=4vvti6"
          },
          "deployment:update": {
            "href": "/restapis/fugvjdxtri/deployments/4vvti6"
          }
        },
        "createdDate": "2016-06-06T17:42:37Z",
        "id": "4vvti6"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/fugvjdxtri/deployments/a9kdln"
          },
          "deployment:delete": {
            "href": "/restapis/fugvjdxtri/deployments/a9kdln"
          },
          "deployment:stages": {
            "href": "/restapis/fugvjdxtri/stages?deployment_id=a9kdln"
          },
          "deployment:update": {
            "href": "/restapis/fugvjdxtri/deployments/a9kdln"
          }
        },
        "createdDate": "2016-06-06T22:18:22Z",
        "description": "stage2 deploy2",
        "id": "a9kdln"
      }
    ]
  }
}
```

## See Also
<a name="API_GetDeployments_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/GetDeployments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDeployments)