GenerateAccessLogs - AWS Amplify

GenerateAccessLogs

Returns the website access logs for a specific time range using a presigned URL.

Request Syntax

POST /apps/appId/accesslogs HTTP/1.1 Content-type: application/json { "domainName": "string", "endTime": number, "startTime": number }

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Request Body

The request accepts the following data in JSON format.

domainName

The name of the domain.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

endTime

The time at which the logs should end. The time range specified is inclusive of the end time.

Type: Timestamp

Required: No

startTime

The time at which the logs should start. The time range specified is inclusive of the start time.

Type: Timestamp

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "logUrl": "string" }

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.

logUrl

The pre-signed URL for the requested access logs.

Type: String

Length Constraints: Maximum length of 1000.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A request contains unexpected data.

HTTP Status Code: 400

InternalFailureException

The service failed to perform an operation due to an internal issue.

HTTP Status Code: 500

NotFoundException

An entity was not found during an operation.

HTTP Status Code: 404

UnauthorizedException

An operation failed due to a lack of access.

HTTP Status Code: 401

See Also

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