CreateResource
Creates a Resource resource.
Request Syntax
POST /restapis/restapi_id/resources/parent_id HTTP/1.1
Content-type: application/json
{
"pathPart": "string"
}URI Request Parameters
The request uses the following URI parameters.
- parent_id
-
The parent resource's identifier.
Required: Yes
- restapi_id
-
The string identifier of the associated RestApi.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- pathPart
-
The last path segment for this resource.
Type: String
Required: Yes
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"id": "string",
"parentId": "string",
"path": "string",
"pathPart": "string",
"resourceMethods": {
"string" : {
"apiKeyRequired": boolean,
"authorizationScopes": [ "string" ],
"authorizationType": "string",
"authorizerId": "string",
"httpMethod": "string",
"methodIntegration": {
"cacheKeyParameters": [ "string" ],
"cacheNamespace": "string",
"connectionId": "string",
"connectionType": "string",
"contentHandling": "string",
"credentials": "string",
"httpMethod": "string",
"integrationResponses": {
"string" : {
"contentHandling": "string",
"responseParameters": {
"string" : "string"
},
"responseTemplates": {
"string" : "string"
},
"selectionPattern": "string",
"statusCode": "string"
}
},
"passthroughBehavior": "string",
"requestParameters": {
"string" : "string"
},
"requestTemplates": {
"string" : "string"
},
"timeoutInMillis": number,
"tlsConfig": {
"insecureSkipVerification": boolean
},
"type": "string",
"uri": "string"
},
"methodResponses": {
"string" : {
"responseModels": {
"string" : "string"
},
"responseParameters": {
"string" : boolean
},
"statusCode": "string"
}
},
"operationName": "string",
"requestModels": {
"string" : "string"
},
"requestParameters": {
"string" : boolean
},
"requestValidatorId": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- id
-
The resource's identifier.
Type: String
- parentId
-
The parent resource's identifier.
Type: String
- path
-
The full path for this resource.
Type: String
- pathPart
-
The last path segment for this resource.
Type: String
- resourceMethods
-
Gets an API resource's method of a given HTTP verb.
Type: String to Method object 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
Create a child resource under an API's root resource
This example illustrates one usage of CreateResource.
Sample Request
POST /restapis/fugvjdxtri/resources/3kzxbg5sa2 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T010429Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}
{
"pathPart" : "res1"
}Sample Response
{
"_links": {
"curies": [
{
"href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
"name": "method",
"templated": true
},
{
"href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
"name": "resource",
"templated": true
}
],
"self": {
"href": "/restapis/fugvjdxtri/resources/47rxl6"
},
"method:by-http-method": {
"href": "/restapis/fugvjdxtri/resources/47rxl6/methods/{http_method}",
"templated": true
},
"method:put": {
"href": "/restapis/fugvjdxtri/resources/47rxl6/methods/{http_method}",
"templated": true
},
"resource:create-child": {
"href": "/restapis/fugvjdxtri/resources/47rxl6"
},
"resource:delete": {
"href": "/restapis/fugvjdxtri/resources/47rxl6"
},
"resource:update": {
"href": "/restapis/fugvjdxtri/resources/47rxl6"
}
},
"id": "47rxl6",
"parentId": "3kzxbg5sa2",
"path": "/res1",
"pathPart": "res1"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
