Table of Contents
PrometheusService.
Client
¶A low-level client representing Amazon Prometheus Service
Amazon Managed Service for Prometheus
client = session.create_client('amp')
These are the available methods:
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
create_workspace
(**kwargs)¶Creates a new AMP workspace.
See also: AWS API Documentation
Request Syntax
response = client.create_workspace(
alias='string',
clientToken='string'
)
alias (string) – An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.
clientToken (string) –
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'arn': 'string',
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
},
'workspaceId': 'string'
}
Response Structure
(dict) –
Represents the output of a CreateWorkspace operation.
arn (string) –
The ARN of the workspace that was just created.
status (dict) –
The status of the workspace that was just created (usually CREATING).
statusCode (string) –
Status code of this workspace.
workspaceId (string) –
The generated ID of the workspace that was just created.
Exceptions
delete_workspace
(**kwargs)¶Deletes an AMP workspace.
See also: AWS API Documentation
Request Syntax
response = client.delete_workspace(
clientToken='string',
workspaceId='string'
)
clientToken (string) –
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
workspaceId (string) –
[REQUIRED]
The ID of the workspace to delete.
None
Exceptions
describe_workspace
(**kwargs)¶Describes an existing AMP workspace.
See also: AWS API Documentation
Request Syntax
response = client.describe_workspace(
workspaceId='string'
)
workspaceId (string) –
[REQUIRED]
The ID of the workspace to describe.
dict
Response Syntax
{
'workspace': {
'alias': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'prometheusEndpoint': 'string',
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
},
'workspaceId': 'string'
}
}
Response Structure
(dict) –
Represents the output of a DescribeWorkspace operation.
workspace (dict) –
The properties of the selected workspace.
alias (string) –
Alias of this workspace.
arn (string) –
The Amazon Resource Name (ARN) of this workspace.
createdAt (datetime) –
The time when the workspace was created.
prometheusEndpoint (string) –
Prometheus endpoint URI.
status (dict) –
The status of this workspace.
statusCode (string) –
Status code of this workspace.
workspaceId (string) –
Unique string identifying this workspace.
Exceptions
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to
ClientMethod
.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
The presigned url
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
list_workspaces
(**kwargs)¶Lists all AMP workspaces, including workspaces being created or deleted.
See also: AWS API Documentation
Request Syntax
response = client.list_workspaces(
alias='string',
maxResults=123,
nextToken='string'
)
alias (string) – Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
maxResults (integer) – Maximum results to return in response (default=100, maximum=1000).
nextToken (string) – Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.
dict
Response Syntax
{
'nextToken': 'string',
'workspaces': [
{
'alias': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
},
'workspaceId': 'string'
},
]
}
Response Structure
(dict) –
Represents the output of a ListWorkspaces operation.
nextToken (string) –
Pagination token to use when requesting the next page in this list.
workspaces (list) –
The list of existing workspaces, including those undergoing creation or deletion.
(dict) –
Represents a summary of the properties of a workspace.
alias (string) –
Alias of this workspace.
arn (string) –
The AmazonResourceName of this workspace.
createdAt (datetime) –
The time when the workspace was created.
status (dict) –
The status of this workspace.
statusCode (string) –
Status code of this workspace.
workspaceId (string) –
Unique string identifying this workspace.
Exceptions
update_workspace_alias
(**kwargs)¶Updates an AMP workspace alias.
See also: AWS API Documentation
Request Syntax
response = client.update_workspace_alias(
alias='string',
clientToken='string',
workspaceId='string'
)
alias (string) – The new alias of the workspace.
clientToken (string) –
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
workspaceId (string) –
[REQUIRED]
The ID of the workspace being updated.
None
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
PrometheusService.Client.exceptions.ResourceNotFoundException
PrometheusService.Client.exceptions.ServiceQuotaExceededException
PrometheusService.Client.exceptions.
AccessDeniedException
¶User does not have sufficient access to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
User does not have sufficient access to perform this action.
message (string) –
Description of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
PrometheusService.Client.exceptions.
ConflictException
¶Updating or deleting a resource can cause an inconsistent state.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'resourceId': 'string',
'resourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Updating or deleting a resource can cause an inconsistent state.
message (string) –
Description of the error.
resourceId (string) –
Identifier of the resource affected.
resourceType (string) –
Type of the resource affected.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
PrometheusService.Client.exceptions.
InternalServerException
¶Unexpected error during processing of request.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'retryAfterSeconds': 123,
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Unexpected error during processing of request.
message (string) –
Description of the error.
retryAfterSeconds (integer) –
Advice to clients on when the call can be safely retried.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
PrometheusService.Client.exceptions.
ResourceNotFoundException
¶Request references a resource which does not exist.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'resourceId': 'string',
'resourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Request references a resource which does not exist.
message (string) –
Description of the error.
resourceId (string) –
Identifier of the resource affected.
resourceType (string) –
Type of the resource affected.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
PrometheusService.Client.exceptions.
ServiceQuotaExceededException
¶Request would cause a service quota to be exceeded.
Example
try:
...
except client.exceptions.ServiceQuotaExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'quotaCode': 'string',
'resourceId': 'string',
'resourceType': 'string',
'serviceCode': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Request would cause a service quota to be exceeded.
message (string) –
Description of the error.
quotaCode (string) –
Service Quotas requirement to identify originating quota.
resourceId (string) –
Identifier of the resource affected.
resourceType (string) –
Type of the resource affected.
serviceCode (string) –
Service Quotas requirement to identify originating service.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
PrometheusService.Client.exceptions.
ThrottlingException
¶Request was denied due to request throttling.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'quotaCode': 'string',
'retryAfterSeconds': 123,
'serviceCode': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Request was denied due to request throttling.
message (string) –
Description of the error.
quotaCode (string) –
Service Quotas requirement to identify originating quota.
retryAfterSeconds (integer) –
Advice to clients on when the call can be safely retried.
serviceCode (string) –
Service Quotas requirement to identify originating service.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
PrometheusService.Client.exceptions.
ValidationException
¶The input fails to satisfy the constraints specified by an AWS service.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'fieldList': [
{
'message': 'string',
'name': 'string'
},
],
'message': 'string',
'reason': 'UNKNOWN_OPERATION'|'CANNOT_PARSE'|'FIELD_VALIDATION_FAILED'|'OTHER',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The input fails to satisfy the constraints specified by an AWS service.
fieldList (list) –
The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message.
(dict) –
Stores information about a field passed inside a request that resulted in an exception.
message (string) –
Message describing why the field failed validation.
name (string) –
The field name.
message (string) –
Description of the error.
reason (string) –
Reason the request failed validation.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
PrometheusService.Paginator.
ListWorkspaces
¶paginator = client.get_paginator('list_workspaces')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from PrometheusService.Client.list_workspaces()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
alias='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
alias (string) – Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'workspaces': [
{
'alias': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
},
'workspaceId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListWorkspaces operation.
workspaces (list) –
The list of existing workspaces, including those undergoing creation or deletion.
(dict) –
Represents a summary of the properties of a workspace.
alias (string) –
Alias of this workspace.
arn (string) –
The AmazonResourceName of this workspace.
createdAt (datetime) –
The time when the workspace was created.
status (dict) –
The status of this workspace.
statusCode (string) –
Status code of this workspace.
workspaceId (string) –
Unique string identifying this workspace.
NextToken (string) –
A token to resume pagination.