Table of Contents
PrometheusService.Client¶A low-level client representing Amazon Prometheus Service
Amazon Managed Service for Prometheus
import boto3
client = boto3.client('amp')
These are the available methods:
can_paginate()close()create_alert_manager_definition()create_logging_configuration()create_rule_groups_namespace()create_workspace()delete_alert_manager_definition()delete_logging_configuration()delete_rule_groups_namespace()delete_workspace()describe_alert_manager_definition()describe_logging_configuration()describe_rule_groups_namespace()describe_workspace()get_paginator()get_waiter()list_rule_groups_namespaces()list_tags_for_resource()list_workspaces()put_alert_manager_definition()put_rule_groups_namespace()tag_resource()untag_resource()update_logging_configuration()update_workspace_alias()can_paginate(operation_name)¶Check if an operation can be paginated.
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.close()¶Closes underlying endpoint connections.
create_alert_manager_definition(**kwargs)¶Create an alert manager definition.
See also: AWS API Documentation
Request Syntax
response = client.create_alert_manager_definition(
clientToken='string',
data=b'bytes',
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The alert manager definition data.
[REQUIRED]
The ID of the workspace in which to create the alert manager definition.
dict
Response Syntax
{
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
}
}
Response Structure
(dict) --
Represents the output of a CreateAlertManagerDefinition operation.
status (dict) --
The status of alert manager definition.
statusCode (string) --
Status code of this definition.
statusReason (string) --
The reason for failure if any.
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionPrometheusService.Client.exceptions.ServiceQuotaExceededExceptioncreate_logging_configuration(**kwargs)¶Create logging configuration.
See also: AWS API Documentation
Request Syntax
response = client.create_logging_configuration(
clientToken='string',
logGroupArn='string',
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The ARN of the CW log group to which the vended log data will be published.
[REQUIRED]
The ID of the workspace to vend logs to.
dict
Response Syntax
{
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
}
}
Response Structure
(dict) --
Represents the output of a CreateLoggingConfiguration operation.
status (dict) --
The status of the logging configuration.
statusCode (string) --
Status code of the logging configuration.
statusReason (string) --
The reason for failure if any.
Exceptions
PrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptioncreate_rule_groups_namespace(**kwargs)¶Create a rule group namespace.
See also: AWS API Documentation
Request Syntax
response = client.create_rule_groups_namespace(
clientToken='string',
data=b'bytes',
name='string',
tags={
'string': 'string'
},
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The namespace data that define the rule groups.
[REQUIRED]
The rule groups namespace name.
Optional, user-provided tags for this rule groups namespace.
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: .
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: _ . : / = + - @
[REQUIRED]
The ID of the workspace in which to create the rule group namespace.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Represents the output of a CreateRuleGroupsNamespace operation.
arn (string) --
The Amazon Resource Name (ARN) of this rule groups namespace.
name (string) --
The rule groups namespace name.
status (dict) --
The status of rule groups namespace.
statusCode (string) --
Status code of this namespace.
statusReason (string) --
The reason for failure if any.
tags (dict) --
The tags of this rule groups namespace.
(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: _ . : / = + - @
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionPrometheusService.Client.exceptions.ServiceQuotaExceededExceptioncreate_workspace(**kwargs)¶Creates a new AMP workspace.
See also: AWS API Documentation
Request Syntax
response = client.create_workspace(
alias='string',
clientToken='string',
tags={
'string': 'string'
}
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
Optional, user-provided tags for this workspace.
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: .
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: _ . : / = + - @
dict
Response Syntax
{
'arn': 'string',
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
},
'tags': {
'string': 'string'
},
'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.
tags (dict) --
The tags of this workspace.
(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: _ . : / = + - @
workspaceId (string) --
The generated ID of the workspace that was just created.
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionPrometheusService.Client.exceptions.ServiceQuotaExceededExceptiondelete_alert_manager_definition(**kwargs)¶Deletes an alert manager definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_alert_manager_definition(
clientToken='string',
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The ID of the workspace in which to delete the alert manager definition.
None
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptiondelete_logging_configuration(**kwargs)¶Delete logging configuration.
See also: AWS API Documentation
Request Syntax
response = client.delete_logging_configuration(
clientToken='string',
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The ID of the workspace to vend logs to.
None
Exceptions
PrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptiondelete_rule_groups_namespace(**kwargs)¶Delete a rule groups namespace.
See also: AWS API Documentation
Request Syntax
response = client.delete_rule_groups_namespace(
clientToken='string',
name='string',
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The rule groups namespace name.
[REQUIRED]
The ID of the workspace to delete rule group definition.
None
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptiondelete_workspace(**kwargs)¶Deletes an AMP workspace.
See also: AWS API Documentation
Request Syntax
response = client.delete_workspace(
clientToken='string',
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The ID of the workspace to delete.
None
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptiondescribe_alert_manager_definition(**kwargs)¶Describes an alert manager definition.
See also: AWS API Documentation
Request Syntax
response = client.describe_alert_manager_definition(
workspaceId='string'
)
[REQUIRED]
The ID of the workspace to describe.
{
'alertManagerDefinition': {
'createdAt': datetime(2015, 1, 1),
'data': b'bytes',
'modifiedAt': datetime(2015, 1, 1),
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
}
}
}
Response Structure
Represents the output of a DescribeAlertManagerDefinition operation.
The properties of the selected workspace's alert manager definition.
The time when the alert manager definition was created.
The alert manager definition.
The time when the alert manager definition was modified.
The status of alert manager definition.
Status code of this definition.
The reason for failure if any.
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptiondescribe_logging_configuration(**kwargs)¶Describes logging configuration.
See also: AWS API Documentation
Request Syntax
response = client.describe_logging_configuration(
workspaceId='string'
)
[REQUIRED]
The ID of the workspace to vend logs to.
{
'loggingConfiguration': {
'createdAt': datetime(2015, 1, 1),
'logGroupArn': 'string',
'modifiedAt': datetime(2015, 1, 1),
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
},
'workspace': 'string'
}
}
Response Structure
Represents the output of a DescribeLoggingConfiguration operation.
Metadata object containing information about the logging configuration of a workspace.
The time when the logging configuration was created.
The ARN of the CW log group to which the vended log data will be published.
The time when the logging configuration was modified.
The status of the logging configuration.
Status code of the logging configuration.
The reason for failure if any.
The workspace where the logging configuration exists.
Exceptions
PrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptiondescribe_rule_groups_namespace(**kwargs)¶Describe a rule groups namespace.
See also: AWS API Documentation
Request Syntax
response = client.describe_rule_groups_namespace(
name='string',
workspaceId='string'
)
[REQUIRED]
The rule groups namespace.
[REQUIRED]
The ID of the workspace to describe.
dict
Response Syntax
{
'ruleGroupsNamespace': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'data': b'bytes',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Represents the output of a DescribeRuleGroupsNamespace operation.
ruleGroupsNamespace (dict) --
The selected rule groups namespace.
arn (string) --
The Amazon Resource Name (ARN) of this rule groups namespace.
createdAt (datetime) --
The time when the rule groups namespace was created.
data (bytes) --
The rule groups namespace data.
modifiedAt (datetime) --
The time when the rule groups namespace was modified.
name (string) --
The rule groups namespace name.
status (dict) --
The status of rule groups namespace.
statusCode (string) --
Status code of this namespace.
statusReason (string) --
The reason for failure if any.
tags (dict) --
The tags of this rule groups namespace.
(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: _ . : / = + - @
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptiondescribe_workspace(**kwargs)¶Describes an existing AMP workspace.
See also: AWS API Documentation
Request Syntax
response = client.describe_workspace(
workspaceId='string'
)
[REQUIRED]
The ID of the workspace to describe.
{
'workspace': {
'alias': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'prometheusEndpoint': 'string',
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
},
'tags': {
'string': 'string'
},
'workspaceId': 'string'
}
}
Response Structure
Represents the output of a DescribeWorkspace operation.
The properties of the selected workspace.
Alias of this workspace.
The Amazon Resource Name (ARN) of this workspace.
The time when the workspace was created.
Prometheus endpoint URI.
The status of this workspace.
Status code of this workspace.
The tags of this workspace.
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: .
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: _ . : / = + - @
Unique string identifying this workspace.
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_rule_groups_namespaces(**kwargs)¶Lists rule groups namespaces.
See also: AWS API Documentation
Request Syntax
response = client.list_rule_groups_namespaces(
maxResults=123,
name='string',
nextToken='string',
workspaceId='string'
)
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'nextToken': 'string',
'ruleGroupsNamespaces': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
Represents the output of a ListRuleGroupsNamespaces operation.
nextToken (string) --
Pagination token to use when requesting the next page in this list.
ruleGroupsNamespaces (list) --
The list of the selected rule groups namespaces.
(dict) --
Represents a summary of the rule groups namespace.
arn (string) --
The Amazon Resource Name (ARN) of this rule groups namespace.
createdAt (datetime) --
The time when the rule groups namespace was created.
modifiedAt (datetime) --
The time when the rule groups namespace was modified.
name (string) --
The rule groups namespace name.
status (dict) --
The status of rule groups namespace.
statusCode (string) --
Status code of this namespace.
statusReason (string) --
The reason for failure if any.
tags (dict) --
The tags of this rule groups namespace.
(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: _ . : / = + - @
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionLists the tags you have assigned to the resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The ARN of the resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
The list of tags assigned to the resource.
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: .
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: _ . : / = + - @
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionlist_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'
)
dict
Response Syntax
{
'nextToken': 'string',
'workspaces': [
{
'alias': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
},
'tags': {
'string': 'string'
},
'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.
tags (dict) --
The tags of this workspace.
(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: _ . : / = + - @
workspaceId (string) --
Unique string identifying this workspace.
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionput_alert_manager_definition(**kwargs)¶Update an alert manager definition.
See also: AWS API Documentation
Request Syntax
response = client.put_alert_manager_definition(
clientToken='string',
data=b'bytes',
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The alert manager definition data.
[REQUIRED]
The ID of the workspace in which to update the alert manager definition.
dict
Response Syntax
{
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
}
}
Response Structure
(dict) --
Represents the output of a PutAlertManagerDefinition operation.
status (dict) --
The status of alert manager definition.
statusCode (string) --
Status code of this definition.
statusReason (string) --
The reason for failure if any.
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionPrometheusService.Client.exceptions.ServiceQuotaExceededExceptionput_rule_groups_namespace(**kwargs)¶Update a rule groups namespace.
See also: AWS API Documentation
Request Syntax
response = client.put_rule_groups_namespace(
clientToken='string',
data=b'bytes',
name='string',
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The namespace data that define the rule groups.
[REQUIRED]
The rule groups namespace name.
[REQUIRED]
The ID of the workspace in which to update the rule group namespace.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Represents the output of a PutRuleGroupsNamespace operation.
arn (string) --
The Amazon Resource Name (ARN) of this rule groups namespace.
name (string) --
The rule groups namespace name.
status (dict) --
The status of rule groups namespace.
statusCode (string) --
Status code of this namespace.
statusReason (string) --
The reason for failure if any.
tags (dict) --
The tags of this rule groups namespace.
(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: _ . : / = + - @
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionPrometheusService.Client.exceptions.ServiceQuotaExceededExceptiontag_resource(**kwargs)¶Creates tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the resource.
[REQUIRED]
The list of tags assigned to the resource.
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: .
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: _ . : / = + - @
dict
Response Syntax
{}
Response Structure
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionuntag_resource(**kwargs)¶Deletes tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource.
[REQUIRED]
One or more tag keys
dict
Response Syntax
{}
Response Structure
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionupdate_logging_configuration(**kwargs)¶Update logging configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_logging_configuration(
clientToken='string',
logGroupArn='string',
workspaceId='string'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The ARN of the CW log group to which the vended log data will be published.
[REQUIRED]
The ID of the workspace to vend logs to.
dict
Response Syntax
{
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
}
}
Response Structure
(dict) --
Represents the output of an UpdateLoggingConfiguration operation.
status (dict) --
The status of the logging configuration.
statusCode (string) --
Status code of the logging configuration.
statusReason (string) --
The reason for failure if any.
Exceptions
PrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionupdate_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'
)
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The ID of the workspace being updated.
None
Exceptions
PrometheusService.Client.exceptions.ThrottlingExceptionPrometheusService.Client.exceptions.ConflictExceptionPrometheusService.Client.exceptions.ValidationExceptionPrometheusService.Client.exceptions.ResourceNotFoundExceptionPrometheusService.Client.exceptions.AccessDeniedExceptionPrometheusService.Client.exceptions.InternalServerExceptionPrometheusService.Client.exceptions.ServiceQuotaExceededExceptionThe available paginators are:
PrometheusService.Paginator.ListRuleGroupsNamespaces¶paginator = client.get_paginator('list_rule_groups_namespaces')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from PrometheusService.Client.list_rule_groups_namespaces().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
name='string',
workspaceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the workspace.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ruleGroupsNamespaces': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'status': {
'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of a ListRuleGroupsNamespaces operation.
ruleGroupsNamespaces (list) --
The list of the selected rule groups namespaces.
(dict) --
Represents a summary of the rule groups namespace.
arn (string) --
The Amazon Resource Name (ARN) of this rule groups namespace.
createdAt (datetime) --
The time when the rule groups namespace was created.
modifiedAt (datetime) --
The time when the rule groups namespace was modified.
name (string) --
The rule groups namespace name.
status (dict) --
The status of rule groups namespace.
statusCode (string) --
Status code of this namespace.
statusReason (string) --
The reason for failure if any.
tags (dict) --
The tags of this rule groups namespace.
(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: _ . : / = + - @
NextToken (string) --
A token to resume pagination.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
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'
},
'tags': {
'string': 'string'
},
'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.
tags (dict) --
The tags of this workspace.
(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: _ . : / = + - @
workspaceId (string) --
Unique string identifying this workspace.
NextToken (string) --
A token to resume pagination.
The available waiters are:
PrometheusService.Waiter.WorkspaceActive¶waiter = client.get_waiter('workspace_active')
wait(**kwargs)¶Polls PrometheusService.Client.describe_workspace() every 2 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
workspaceId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the workspace to describe.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 60
None
PrometheusService.Waiter.WorkspaceDeleted¶waiter = client.get_waiter('workspace_deleted')
wait(**kwargs)¶Polls PrometheusService.Client.describe_workspace() every 2 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
workspaceId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the workspace to describe.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 60
None