Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeScraper

The DescribeScraper operation displays information about an existing scraper.

Request Syntax


GET /scrapers/scraperId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

scraperId

The ID of the scraper to describe.

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

Pattern: [0-9A-Za-z][-.0-9A-Z_a-z]*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "scraper": { 
      "alias": "string",
      "arn": "string",
      "createdAt": number,
      "destination": { ... },
      "lastModifiedAt": number,
      "roleArn": "string",
      "roleConfiguration": { 
         "sourceRoleArn": "string",
         "targetRoleArn": "string"
      },
      "scrapeConfiguration": { ... },
      "scraperId": "string",
      "source": { ... },
      "status": { 
         "statusCode": "string"
      },
      "statusReason": "string",
      "tags": { 
         "string" : "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.

scraper

Contains details about the scraper.

Type: ScraperDescription object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

message: Description of the error.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during the processing of the request.

message: Description of the error.
retryAfterSeconds: Advice to clients on when the call can be safely retried.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resources that doesn't exist.

message: Description of the error.
resourceId: Identifier of the resource affected.
resourceType: Type of the resource affected.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

message: Description of the error.
quotaCode: Service quotas code for the originating quota.
retryAfterSeconds: Advice to clients on when the call can be safely retried.
serviceCode: Service quotas code for the originating service.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The field that caused the error, if applicable.
message: Description of the error.
reason: Reason the request failed validation.

HTTP Status Code: 400