PrometheusService / Client / describe_scraper
describe_scraper#
- PrometheusService.Client.describe_scraper(**kwargs)#
Describe an existing scraper.
See also: AWS API Documentation
Request Syntax
response = client.describe_scraper( scraperId='string' )
- Parameters:
scraperId (string) –
[REQUIRED]
The IDs of the scraper to describe.
- Return type:
dict
- Returns:
Response Syntax
{ 'scraper': { 'alias': 'string', 'scraperId': 'string', 'arn': 'string', 'roleArn': 'string', 'status': { 'statusCode': 'CREATING'|'ACTIVE'|'DELETING'|'CREATION_FAILED'|'DELETION_FAILED' }, 'createdAt': datetime(2015, 1, 1), 'lastModifiedAt': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'statusReason': 'string', 'scrapeConfiguration': { 'configurationBlob': b'bytes' }, 'source': { 'eksConfiguration': { 'clusterArn': 'string', 'securityGroupIds': [ 'string', ], 'subnetIds': [ 'string', ] } }, 'destination': { 'ampConfiguration': { 'workspaceArn': 'string' } } } }
Response Structure
(dict) –
Represents the output of a DescribeScraper operation.
scraper (dict) –
The properties of the selected scrapers.
alias (string) –
Alias of this scraper.
scraperId (string) –
Unique string identifying this scraper.
arn (string) –
The Amazon Resource Name (ARN) of this scraper.
roleArn (string) –
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.
status (dict) –
The status of this scraper.
statusCode (string) –
Status code of this scraper.
createdAt (datetime) –
The time when the scraper was created.
lastModifiedAt (datetime) –
The time when the scraper was last modified.
tags (dict) –
The tags of this scraper.
(string) –
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with
aws:
.(string) –
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @
statusReason (string) –
The reason for failure if any.
scrapeConfiguration (dict) –
The configuration used to create the scraper.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
configurationBlob
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
configurationBlob (bytes) –
Binary data representing a Prometheus configuration file.
source (dict) –
The source that the scraper is discovering and collecting metrics from.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
eksConfiguration
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
eksConfiguration (dict) –
A representation of an EKS source.
clusterArn (string) –
The ARN of an EKS cluster.
securityGroupIds (list) –
A list of security group IDs specified for VPC configuration.
(string) –
ID of a VPC security group.
subnetIds (list) –
A list of subnet IDs specified for VPC configuration.
(string) –
ID of a VPC subnet.
destination (dict) –
The destination that the scraper is producing metrics to.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
ampConfiguration
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
ampConfiguration (dict) –
A representation of an AMP destination.
workspaceArn (string) –
The ARN of an AMP workspace.
Exceptions
PrometheusService.Client.exceptions.ThrottlingException
PrometheusService.Client.exceptions.ValidationException
PrometheusService.Client.exceptions.ResourceNotFoundException
PrometheusService.Client.exceptions.AccessDeniedException
PrometheusService.Client.exceptions.InternalServerException