GetApi
Retrieves an Api object.
Request Syntax
GET /v2/apis/apiId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- apiId
-
The
ApiID.Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"api": {
"apiArn": "string",
"apiId": "string",
"created": number,
"dns": {
"string" : "string"
},
"eventConfig": {
"authProviders": [
{
"authType": "string",
"cognitoConfig": {
"appIdClientRegex": "string",
"awsRegion": "string",
"userPoolId": "string"
},
"lambdaAuthorizerConfig": {
"authorizerResultTtlInSeconds": number,
"authorizerUri": "string",
"identityValidationExpression": "string"
},
"openIDConnectConfig": {
"authTTL": number,
"clientId": "string",
"iatTTL": number,
"issuer": "string"
}
}
],
"connectionAuthModes": [
{
"authType": "string"
}
],
"defaultPublishAuthModes": [
{
"authType": "string"
}
],
"defaultSubscribeAuthModes": [
{
"authType": "string"
}
],
"logConfig": {
"cloudWatchLogsRoleArn": "string",
"logLevel": "string"
}
},
"name": "string",
"ownerContact": "string",
"tags": {
"string" : "string"
},
"wafWebAclArn": "string",
"xrayEnabled": boolean
}
}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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to perform this operation on this resource.
HTTP Status Code: 403
- BadRequestException
-
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.
HTTP Status Code: 400
- InternalFailureException
-
An internal AWS AppSync error occurred. Try your request again.
HTTP Status Code: 500
- NotFoundException
-
The resource specified in the request was not found. Check the resource, and then try again.
HTTP Status Code: 404
- UnauthorizedException
-
You aren't authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
