DescribeScraperLoggingConfiguration - Amazon Managed Service for Prometheus
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

DescribeScraperLoggingConfiguration

Describes the logging configuration for a Amazon Managed Service for Prometheus scraper.

Request Syntax

GET /scrapers/scraperId/logging-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

scraperId

The ID of the scraper whose logging configuration will be described.

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

{
   "loggingDestination": { ... },
   "modifiedAt": number,
   "scraperComponents": [ 
      { 
         "config": { 
            "options": { 
               "string" : "string" 
            }
         },
         "type": "string"
      }
   ],
   "scraperId": "string",
   "status": { 
      "statusCode": "string",
      "statusReason": "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.

loggingDestination

The destination where scraper logs are sent.

Type: ScraperLoggingDestination object

Note: This object is a Union. Only one member of this object can be specified or returned.

modifiedAt

The date and time when the logging configuration was last modified.

Type: Timestamp

scraperComponents

The list of scraper components configured for logging.

Type: Array of ScraperComponent objects

Array Members: Minimum number of 1 item.

scraperId

The ID of the scraper.

Type: String

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

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

status

The status of the scraper logging configuration.

Type: ScraperLoggingConfigurationStatus 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.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during the processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resources that doesn't exist.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400

See Also

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