SDK for PHP 3.x

Client: Aws\PrometheusService\PrometheusServiceClient
Service ID: amp
Version: 2020-08-01

This page describes the parameters and results for the operations of the Amazon Prometheus Service (2020-08-01), and shows how to use the Aws\PrometheusService\PrometheusServiceClient object to call the described operations. This documentation is specific to the 2020-08-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateAlertManagerDefinition ( array $params = [] )
The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace.
CreateLoggingConfiguration ( array $params = [] )
The CreateLoggingConfiguration operation creates a logging configuration for the workspace.
CreateRuleGroupsNamespace ( array $params = [] )
The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace.
CreateScraper ( array $params = [] )
The CreateScraper operation creates a scraper to collect metrics.
CreateWorkspace ( array $params = [] )
Creates a Prometheus workspace.
DeleteAlertManagerDefinition ( array $params = [] )
Deletes the alert manager definition from a workspace.
DeleteLoggingConfiguration ( array $params = [] )
Deletes the logging configuration for a workspace.
DeleteRuleGroupsNamespace ( array $params = [] )
Deletes one rule groups namespace and its associated rule groups definition.
DeleteScraper ( array $params = [] )
The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
DeleteWorkspace ( array $params = [] )
Deletes an existing workspace.
DescribeAlertManagerDefinition ( array $params = [] )
Retrieves the full information about the alert manager definition for a workspace.
DescribeLoggingConfiguration ( array $params = [] )
Returns complete information about the current logging configuration of the workspace.
DescribeRuleGroupsNamespace ( array $params = [] )
Returns complete information about one rule groups namespace.
DescribeScraper ( array $params = [] )
The DescribeScraper operation displays information about an existing scraper.
DescribeWorkspace ( array $params = [] )
Returns information about an existing workspace.
GetDefaultScraperConfiguration ( array $params = [] )
The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
ListRuleGroupsNamespaces ( array $params = [] )
Returns a list of rule groups namespaces in a workspace.
ListScrapers ( array $params = [] )
The ListScrapers operation lists all of the scrapers in your account.
ListTagsForResource ( array $params = [] )
The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.
ListWorkspaces ( array $params = [] )
Lists all of the Amazon Managed Service for Prometheus workspaces in your account.
PutAlertManagerDefinition ( array $params = [] )
Updates an existing alert manager definition in a workspace.
PutRuleGroupsNamespace ( array $params = [] )
Updates an existing rule groups namespace within a workspace.
TagResource ( array $params = [] )
The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource.
UntagResource ( array $params = [] )
Removes the specified tags from an Amazon Managed Service for Prometheus resource.
UpdateLoggingConfiguration ( array $params = [] )
Updates the log group ARN or the workspace ID of the current logging configuration.
UpdateScraper ( array $params = [] )
Updates an existing scraper.
UpdateWorkspaceAlias ( array $params = [] )
Updates the alias of an existing workspace.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListRuleGroupsNamespaces
ListScrapers
ListWorkspaces

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
ScraperActive DescribeScraper 2 60
ScraperDeleted DescribeScraper 2 60
WorkspaceActive DescribeWorkspace 2 60
WorkspaceDeleted DescribeWorkspace 2 60

Operations

CreateAlertManagerDefinition

$result = $client->createAlertManagerDefinition([/* ... */]);
$promise = $client->createAlertManagerDefinitionAsync([/* ... */]);

The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.

Parameter Syntax

$result = $client->createAlertManagerDefinition([
    'clientToken' => '<string>',
    'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

data
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The alert manager definition to add. A base64-encoded version of the YAML alert manager definition file.

For details about the alert manager definition, see AlertManagedDefinitionData.

workspaceId
Required: Yes
Type: string

The ID of the workspace to add the alert manager definition to.

Result Syntax

[
    'status' => [
        'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
        'statusReason' => '<string>',
    ],
]

Result Details

Members
status
Required: Yes
Type: AlertManagerDefinitionStatus structure

A structure that displays the current status of the alert manager definition.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ServiceQuotaExceededException:

Completing the request would cause a service quota to be exceeded.

CreateLoggingConfiguration

$result = $client->createLoggingConfiguration([/* ... */]);
$promise = $client->createLoggingConfigurationAsync([/* ... */]);

The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

Parameter Syntax

$result = $client->createLoggingConfiguration([
    'clientToken' => '<string>',
    'logGroupArn' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

logGroupArn
Required: Yes
Type: string

The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.

workspaceId
Required: Yes
Type: string

The ID of the workspace to create the logging configuration for.

Result Syntax

[
    'status' => [
        'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
        'statusReason' => '<string>',
    ],
]

Result Details

Members
status
Required: Yes
Type: LoggingConfigurationStatus structure

A structure that displays the current status of the logging configuration.

Errors

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

CreateRuleGroupsNamespace

$result = $client->createRuleGroupsNamespace([/* ... */]);
$promise = $client->createRuleGroupsNamespaceAsync([/* ... */]);

The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.

Parameter Syntax

$result = $client->createRuleGroupsNamespace([
    'clientToken' => '<string>',
    'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

data
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The rules file to use in the new namespace.

Contains the base64-encoded version of the YAML rules file.

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

name
Required: Yes
Type: string

The name for the new rule groups namespace.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values to associate with the rule groups namespace.

workspaceId
Required: Yes
Type: string

The ID of the workspace to add the rule groups namespace.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
    'status' => [
        'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
        'statusReason' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the new rule groups namespace.

name
Required: Yes
Type: string

The name of the new rule groups namespace.

status
Required: Yes
Type: RuleGroupsNamespaceStatus structure

A structure that returns the current status of the rule groups namespace.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values that are associated with the namespace.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ServiceQuotaExceededException:

Completing the request would cause a service quota to be exceeded.

CreateScraper

$result = $client->createScraper([/* ... */]);
$promise = $client->createScraperAsync([/* ... */]);

The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.

An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.

The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.

For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.

Parameter Syntax

$result = $client->createScraper([
    'alias' => '<string>',
    'clientToken' => '<string>',
    'destination' => [ // REQUIRED
        'ampConfiguration' => [
            'workspaceArn' => '<string>', // REQUIRED
        ],
    ],
    'scrapeConfiguration' => [ // REQUIRED
        'configurationBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'source' => [ // REQUIRED
        'eksConfiguration' => [
            'clusterArn' => '<string>', // REQUIRED
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...], // REQUIRED
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
alias
Type: string

(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.

clientToken
Type: string

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

destination
Required: Yes
Type: Destination structure

The Amazon Managed Service for Prometheus workspace to send metrics to.

scrapeConfiguration
Required: Yes
Type: ScrapeConfiguration structure

The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

source
Required: Yes
Type: Source structure

The Amazon EKS cluster from which the scraper will collect metrics.

tags
Type: Associative array of custom strings keys (TagKey) to strings

(Optional) The list of tag keys and values to associate with the scraper.

Result Syntax

[
    'arn' => '<string>',
    'scraperId' => '<string>',
    'status' => [
        'statusCode' => 'CREATING|UPDATING|ACTIVE|DELETING|CREATION_FAILED|UPDATE_FAILED|DELETION_FAILED',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the new scraper.

scraperId
Required: Yes
Type: string

The ID of the new scraper.

status
Required: Yes
Type: ScraperStatus structure

A structure that displays the current status of the scraper.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values that are associated with the scraper.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ServiceQuotaExceededException:

Completing the request would cause a service quota to be exceeded.

CreateWorkspace

$result = $client->createWorkspace([/* ... */]);
$promise = $client->createWorkspaceAsync([/* ... */]);

Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.

Parameter Syntax

$result = $client->createWorkspace([
    'alias' => '<string>',
    'clientToken' => '<string>',
    'kmsKeyArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
alias
Type: string

An alias that you assign to this workspace to help you identify it. It does not need to be unique.

Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.

clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

kmsKeyArn
Type: string

(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values to associate with the workspace.

Result Syntax

[
    'arn' => '<string>',
    'kmsKeyArn' => '<string>',
    'status' => [
        'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED',
    ],
    'tags' => ['<string>', ...],
    'workspaceId' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN for the new workspace.

kmsKeyArn
Type: string

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

status
Required: Yes
Type: WorkspaceStatus structure

The current status of the new workspace. Immediately after you create the workspace, the status is usually CREATING.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values that are associated with the workspace.

workspaceId
Required: Yes
Type: string

The unique ID for the new workspace.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ServiceQuotaExceededException:

Completing the request would cause a service quota to be exceeded.

DeleteAlertManagerDefinition

$result = $client->deleteAlertManagerDefinition([/* ... */]);
$promise = $client->deleteAlertManagerDefinitionAsync([/* ... */]);

Deletes the alert manager definition from a workspace.

Parameter Syntax

$result = $client->deleteAlertManagerDefinition([
    'clientToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

workspaceId
Required: Yes
Type: string

The ID of the workspace to delete the alert manager definition from.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

DeleteLoggingConfiguration

$result = $client->deleteLoggingConfiguration([/* ... */]);
$promise = $client->deleteLoggingConfigurationAsync([/* ... */]);

Deletes the logging configuration for a workspace.

Parameter Syntax

$result = $client->deleteLoggingConfiguration([
    'clientToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

workspaceId
Required: Yes
Type: string

The ID of the workspace containing the logging configuration to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

DeleteRuleGroupsNamespace

$result = $client->deleteRuleGroupsNamespace([/* ... */]);
$promise = $client->deleteRuleGroupsNamespaceAsync([/* ... */]);

Deletes one rule groups namespace and its associated rule groups definition.

Parameter Syntax

$result = $client->deleteRuleGroupsNamespace([
    'clientToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

name
Required: Yes
Type: string

The name of the rule groups namespace to delete.

workspaceId
Required: Yes
Type: string

The ID of the workspace containing the rule groups namespace and definition to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

DeleteScraper

$result = $client->deleteScraper([/* ... */]);
$promise = $client->deleteScraperAsync([/* ... */]);

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

Parameter Syntax

$result = $client->deleteScraper([
    'clientToken' => '<string>',
    'scraperId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

scraperId
Required: Yes
Type: string

The ID of the scraper to delete.

Result Syntax

[
    'scraperId' => '<string>',
    'status' => [
        'statusCode' => 'CREATING|UPDATING|ACTIVE|DELETING|CREATION_FAILED|UPDATE_FAILED|DELETION_FAILED',
    ],
]

Result Details

Members
scraperId
Required: Yes
Type: string

The ID of the scraper to delete.

status
Required: Yes
Type: ScraperStatus structure

The current status of the scraper.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

DeleteWorkspace

$result = $client->deleteWorkspace([/* ... */]);
$promise = $client->deleteWorkspaceAsync([/* ... */]);

Deletes an existing workspace.

When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.

Parameter Syntax

$result = $client->deleteWorkspace([
    'clientToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

workspaceId
Required: Yes
Type: string

The ID of the workspace to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

DescribeAlertManagerDefinition

$result = $client->describeAlertManagerDefinition([/* ... */]);
$promise = $client->describeAlertManagerDefinitionAsync([/* ... */]);

Retrieves the full information about the alert manager definition for a workspace.

Parameter Syntax

$result = $client->describeAlertManagerDefinition([
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
workspaceId
Required: Yes
Type: string

The ID of the workspace to retrieve the alert manager definition from.

Result Syntax

[
    'alertManagerDefinition' => [
        'createdAt' => <DateTime>,
        'data' => <string || resource || Psr\Http\Message\StreamInterface>,
        'modifiedAt' => <DateTime>,
        'status' => [
            'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
            'statusReason' => '<string>',
        ],
    ],
]

Result Details

Members
alertManagerDefinition
Required: Yes
Type: AlertManagerDefinitionDescription structure

The alert manager definition.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

DescribeLoggingConfiguration

$result = $client->describeLoggingConfiguration([/* ... */]);
$promise = $client->describeLoggingConfigurationAsync([/* ... */]);

Returns complete information about the current logging configuration of the workspace.

Parameter Syntax

$result = $client->describeLoggingConfiguration([
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
workspaceId
Required: Yes
Type: string

The ID of the workspace to describe the logging configuration for.

Result Syntax

[
    'loggingConfiguration' => [
        'createdAt' => <DateTime>,
        'logGroupArn' => '<string>',
        'modifiedAt' => <DateTime>,
        'status' => [
            'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
            'statusReason' => '<string>',
        ],
        'workspace' => '<string>',
    ],
]

Result Details

Members
loggingConfiguration
Required: Yes
Type: LoggingConfigurationMetadata structure

A structure that displays the information about the logging configuration.

Errors

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

DescribeRuleGroupsNamespace

$result = $client->describeRuleGroupsNamespace([/* ... */]);
$promise = $client->describeRuleGroupsNamespaceAsync([/* ... */]);

Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.

Parameter Syntax

$result = $client->describeRuleGroupsNamespace([
    'name' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the rule groups namespace that you want information for.

workspaceId
Required: Yes
Type: string

The ID of the workspace containing the rule groups namespace.

Result Syntax

[
    'ruleGroupsNamespace' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'data' => <string || resource || Psr\Http\Message\StreamInterface>,
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'status' => [
            'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
            'statusReason' => '<string>',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
ruleGroupsNamespace
Required: Yes
Type: RuleGroupsNamespaceDescription structure

The information about the rule groups namespace.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

DescribeScraper

$result = $client->describeScraper([/* ... */]);
$promise = $client->describeScraperAsync([/* ... */]);

The DescribeScraper operation displays information about an existing scraper.

Parameter Syntax

$result = $client->describeScraper([
    'scraperId' => '<string>', // REQUIRED
]);

Parameter Details

Members
scraperId
Required: Yes
Type: string

The ID of the scraper to describe.

Result Syntax

[
    'scraper' => [
        'alias' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'destination' => [
            'ampConfiguration' => [
                'workspaceArn' => '<string>',
            ],
        ],
        'lastModifiedAt' => <DateTime>,
        'roleArn' => '<string>',
        'scrapeConfiguration' => [
            'configurationBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
        ],
        'scraperId' => '<string>',
        'source' => [
            'eksConfiguration' => [
                'clusterArn' => '<string>',
                'securityGroupIds' => ['<string>', ...],
                'subnetIds' => ['<string>', ...],
            ],
        ],
        'status' => [
            'statusCode' => 'CREATING|UPDATING|ACTIVE|DELETING|CREATION_FAILED|UPDATE_FAILED|DELETION_FAILED',
        ],
        'statusReason' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
scraper
Required: Yes
Type: ScraperDescription structure

Contains details about the scraper.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

DescribeWorkspace

$result = $client->describeWorkspace([/* ... */]);
$promise = $client->describeWorkspaceAsync([/* ... */]);

Returns information about an existing workspace.

Parameter Syntax

$result = $client->describeWorkspace([
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
workspaceId
Required: Yes
Type: string

The ID of the workspace to describe.

Result Syntax

[
    'workspace' => [
        'alias' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'kmsKeyArn' => '<string>',
        'prometheusEndpoint' => '<string>',
        'status' => [
            'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED',
        ],
        'tags' => ['<string>', ...],
        'workspaceId' => '<string>',
    ],
]

Result Details

Members
workspace
Required: Yes
Type: WorkspaceDescription structure

A structure that contains details about the workspace.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

GetDefaultScraperConfiguration

$result = $client->getDefaultScraperConfiguration([/* ... */]);
$promise = $client->getDefaultScraperConfigurationAsync([/* ... */]);

The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

Parameter Syntax

$result = $client->getDefaultScraperConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'configuration' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members
configuration
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The configuration file. Base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListRuleGroupsNamespaces

$result = $client->listRuleGroupsNamespaces([/* ... */]);
$promise = $client->listRuleGroupsNamespacesAsync([/* ... */]);

Returns a list of rule groups namespaces in a workspace.

Parameter Syntax

$result = $client->listRuleGroupsNamespaces([
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return. The default is 100.

name
Type: string

Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.

nextToken
Type: string

The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

For example, if your initial request has maxResults of 10, and there are 12 rule groups namespaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 namespaces.

workspaceId
Required: Yes
Type: string

The ID of the workspace containing the rule groups namespaces.

Result Syntax

[
    'nextToken' => '<string>',
    'ruleGroupsNamespaces' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'modifiedAt' => <DateTime>,
            'name' => '<string>',
            'status' => [
                'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
                'statusReason' => '<string>',
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A token indicating that there are more results to retrieve. You can use this token as part of your next ListRuleGroupsNamespaces request to retrieve those results.

ruleGroupsNamespaces
Required: Yes
Type: Array of RuleGroupsNamespaceSummary structures

The returned list of rule groups namespaces.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListScrapers

$result = $client->listScrapers([/* ... */]);
$promise = $client->listScrapersAsync([/* ... */]);

The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.

Parameter Syntax

$result = $client->listScrapers([
    'filters' => [
        '<FilterKey>' => ['<string>', ...],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
filters
Type: Associative array of custom strings keys (FilterKey) to stringss

(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include status, sourceArn, destinationArn, and alias.

Filters on the same key are OR'd together, and filters on different keys are AND'd together. For example, status=ACTIVE&status=CREATING&alias=Test, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.

To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:

status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012

If this is included, it filters the results to only the scrapers that match the filter.

maxResults
Type: int

Optional) The maximum number of scrapers to return in one ListScrapers operation. The range is 1-1000.

If you omit this parameter, the default of 100 is used.

nextToken
Type: string

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'nextToken' => '<string>',
    'scrapers' => [
        [
            'alias' => '<string>',
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'destination' => [
                'ampConfiguration' => [
                    'workspaceArn' => '<string>',
                ],
            ],
            'lastModifiedAt' => <DateTime>,
            'roleArn' => '<string>',
            'scraperId' => '<string>',
            'source' => [
                'eksConfiguration' => [
                    'clusterArn' => '<string>',
                    'securityGroupIds' => ['<string>', ...],
                    'subnetIds' => ['<string>', ...],
                ],
            ],
            'status' => [
                'statusCode' => 'CREATING|UPDATING|ACTIVE|DELETING|CREATION_FAILED|UPDATE_FAILED|DELETION_FAILED',
            ],
            'statusReason' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A token indicating that there are more results to retrieve. You can use this token as part of your next ListScrapers operation to retrieve those results.

scrapers
Required: Yes
Type: Array of ScraperSummary structures

A list of ScraperSummary structures giving information about scrapers in the account that match the filters provided.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are scrapers, workspaces, and rule groups namespaces.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource to list tages for. Must be a workspace, scraper, or rule groups namespace resource.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values associated with the resource.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ListWorkspaces

$result = $client->listWorkspaces([/* ... */]);
$promise = $client->listWorkspacesAsync([/* ... */]);

Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.

Parameter Syntax

$result = $client->listWorkspaces([
    'alias' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
alias
Type: string

If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

maxResults
Type: int

The maximum number of workspaces to return per request. The default is 100.

nextToken
Type: string

The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

Result Syntax

[
    'nextToken' => '<string>',
    'workspaces' => [
        [
            'alias' => '<string>',
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'kmsKeyArn' => '<string>',
            'status' => [
                'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED',
            ],
            'tags' => ['<string>', ...],
            'workspaceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A token indicating that there are more results to retrieve. You can use this token as part of your next ListWorkspaces request to retrieve those results.

workspaces
Required: Yes
Type: Array of WorkspaceSummary structures

An array of WorkspaceSummary structures containing information about the workspaces requested.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

PutAlertManagerDefinition

$result = $client->putAlertManagerDefinition([/* ... */]);
$promise = $client->putAlertManagerDefinitionAsync([/* ... */]);

Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.

Parameter Syntax

$result = $client->putAlertManagerDefinition([
    'clientToken' => '<string>',
    'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

data
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file.

For details about the alert manager definition, see AlertManagedDefinitionData.

workspaceId
Required: Yes
Type: string

The ID of the workspace to update the alert manager definition in.

Result Syntax

[
    'status' => [
        'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
        'statusReason' => '<string>',
    ],
]

Result Details

Members
status
Required: Yes
Type: AlertManagerDefinitionStatus structure

A structure that returns the current status of the alert manager definition.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ServiceQuotaExceededException:

Completing the request would cause a service quota to be exceeded.

PutRuleGroupsNamespace

$result = $client->putRuleGroupsNamespace([/* ... */]);
$promise = $client->putRuleGroupsNamespaceAsync([/* ... */]);

Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.

You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.

Parameter Syntax

$result = $client->putRuleGroupsNamespace([
    'clientToken' => '<string>',
    'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'name' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

data
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file.

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

name
Required: Yes
Type: string

The name of the rule groups namespace that you are updating.

workspaceId
Required: Yes
Type: string

The ID of the workspace where you are updating the rule groups namespace.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
    'status' => [
        'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
        'statusReason' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the rule groups namespace.

name
Required: Yes
Type: string

The name of the rule groups namespace that was updated.

status
Required: Yes
Type: RuleGroupsNamespaceStatus structure

A structure that includes the current status of the rule groups namespace.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values that are associated with the namespace.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ServiceQuotaExceededException:

Completing the request would cause a service quota to be exceeded.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.

If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. To remove a tag, use UntagResource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource to apply tags to.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values to associate with the resource.

Keys must not begin with aws:.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource from which to remove a tag.

tagKeys
Required: Yes
Type: Array of strings

The keys of the tags to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

UpdateLoggingConfiguration

$result = $client->updateLoggingConfiguration([/* ... */]);
$promise = $client->updateLoggingConfigurationAsync([/* ... */]);

Updates the log group ARN or the workspace ID of the current logging configuration.

Parameter Syntax

$result = $client->updateLoggingConfiguration([
    'clientToken' => '<string>',
    'logGroupArn' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

logGroupArn
Required: Yes
Type: string

The ARN of the CloudWatch log group to which the vended log data will be published.

workspaceId
Required: Yes
Type: string

The ID of the workspace to update the logging configuration for.

Result Syntax

[
    'status' => [
        'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
        'statusReason' => '<string>',
    ],
]

Result Details

Members
status
Required: Yes
Type: LoggingConfigurationStatus structure

A structure that contains the current status of the logging configuration.

Errors

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

UpdateScraper

$result = $client->updateScraper([/* ... */]);
$promise = $client->updateScraperAsync([/* ... */]);

Updates an existing scraper.

You can't use this function to update the source from which the scraper is collecting metrics. To change the source, delete the scraper and create a new one.

Parameter Syntax

$result = $client->updateScraper([
    'alias' => '<string>',
    'clientToken' => '<string>',
    'destination' => [
        'ampConfiguration' => [
            'workspaceArn' => '<string>', // REQUIRED
        ],
    ],
    'scrapeConfiguration' => [
        'configurationBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'scraperId' => '<string>', // REQUIRED
]);

Parameter Details

Members
alias
Type: string

The new alias of the scraper.

clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

destination
Type: Destination structure

The new Amazon Managed Service for Prometheus workspace to send metrics to.

scrapeConfiguration
Type: ScrapeConfiguration structure

Contains the base-64 encoded YAML configuration for the scraper.

For more information about configuring a scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.

scraperId
Required: Yes
Type: string

The ID of the scraper to update.

Result Syntax

[
    'arn' => '<string>',
    'scraperId' => '<string>',
    'status' => [
        'statusCode' => 'CREATING|UPDATING|ACTIVE|DELETING|CREATION_FAILED|UPDATE_FAILED|DELETION_FAILED',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the updated scraper.

scraperId
Required: Yes
Type: string

The ID of the updated scraper.

status
Required: Yes
Type: ScraperStatus structure

A structure that displays the current status of the scraper.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values that are associated with the scraper.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ServiceQuotaExceededException:

Completing the request would cause a service quota to be exceeded.

UpdateWorkspaceAlias

$result = $client->updateWorkspaceAlias([/* ... */]);
$promise = $client->updateWorkspaceAliasAsync([/* ... */]);

Updates the alias of an existing workspace.

Parameter Syntax

$result = $client->updateWorkspaceAlias([
    'alias' => '<string>',
    'clientToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
alias
Type: string

The new alias for the workspace. It does not need to be unique.

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

clientToken
Type: string

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

workspaceId
Required: Yes
Type: string

The ID of the workspace to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request would cause an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The request references a resources that doesn't exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An unexpected error occurred during the processing of the request.

ServiceQuotaExceededException:

Completing the request would cause a service quota to be exceeded.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
Required: Yes
Type: string

Description of the error.

AlertManagerDefinitionDescription

Description

The details of an alert manager definition. It is the configuration for the alert manager, including information about receivers for routing alerts.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the alert manager definition was created.

data
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The actual alert manager definition.

For details about the alert manager definition, see AlertManagedDefinitionData.

modifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the alert manager definition was most recently changed.

status
Required: Yes
Type: AlertManagerDefinitionStatus structure

A structure that displays the current status of the alert manager definition..

AlertManagerDefinitionStatus

Description

The status of the alert manager.

Members
statusCode
Required: Yes
Type: string

The current status of the alert manager.

statusReason
Type: string

If there is a failure, the reason for the failure.

AmpConfiguration

Description

The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.

Members
workspaceArn
Required: Yes
Type: string

ARN of the Amazon Managed Service for Prometheus workspace.

ConflictException

Description

The request would cause an inconsistent state.

Members
message
Required: Yes
Type: string

Description of the error.

resourceId
Required: Yes
Type: string

Identifier of the resource affected.

resourceType
Required: Yes
Type: string

Type of the resource affected.

Destination

Description

Where to send the metrics from a scraper.

Members
ampConfiguration
Type: AmpConfiguration structure

The Amazon Managed Service for Prometheus workspace to send metrics to.

EksConfiguration

Description

The EksConfiguration structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.

Members
clusterArn
Required: Yes
Type: string

ARN of the Amazon EKS cluster.

securityGroupIds
Type: Array of strings

A list of the security group IDs for the Amazon EKS cluster VPC configuration.

subnetIds
Required: Yes
Type: Array of strings

A list of subnet IDs for the Amazon EKS cluster VPC configuration.

InternalServerException

Description

An unexpected error occurred during the processing of the request.

Members
message
Required: Yes
Type: string

Description of the error.

retryAfterSeconds
Type: int

Advice to clients on when the call can be safely retried.

LoggingConfigurationMetadata

Description

Contains information about the logging configuration for the workspace.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the logging configuration was created.

logGroupArn
Required: Yes
Type: string

The ARN of the CloudWatch log group to which the vended log data will be published.

modifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the logging configuration was most recently changed.

status
Required: Yes
Type: LoggingConfigurationStatus structure

The current status of the logging configuration.

workspace
Required: Yes
Type: string

The ID of the workspace the logging configuration is for.

LoggingConfigurationStatus

Description

The status of the logging configuration.

Members
statusCode
Required: Yes
Type: string

The current status of the logging configuration.

statusReason
Type: string

If failed, the reason for the failure.

ResourceNotFoundException

Description

The request references a resources that doesn't exist.

Members
message
Required: Yes
Type: string

Description of the error.

resourceId
Required: Yes
Type: string

Identifier of the resource affected.

resourceType
Required: Yes
Type: string

Type of the resource affected.

RuleGroupsNamespaceDescription

Description

The details about one rule groups namespace.

Members
arn
Required: Yes
Type: string

The ARN of the rule groups namespace. For example, arn:aws:aps:<region>:123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the rule groups namespace was created.

data
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The rule groups file used in the namespace.

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

modifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the rule groups namespace was most recently changed.

name
Required: Yes
Type: string

The name of the rule groups namespace.

status
Required: Yes
Type: RuleGroupsNamespaceStatus structure

The current status of the rule groups namespace.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values that are associated with the rule groups namespace.

RuleGroupsNamespaceStatus

Description

The status information about a rule groups namespace.

Members
statusCode
Required: Yes
Type: string

The current status of the namespace.

statusReason
Type: string

The reason for the failure, if any.

RuleGroupsNamespaceSummary

Description

The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace.

Members
arn
Required: Yes
Type: string

The ARN of the rule groups namespace.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the rule groups namespace was created.

modifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the rule groups namespace was most recently changed.

name
Required: Yes
Type: string

The name of the rule groups namespace.

status
Required: Yes
Type: RuleGroupsNamespaceStatus structure

A structure that displays the current status of the rule groups namespace.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values that are associated with the rule groups namespace.

ScrapeConfiguration

Description

A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

Members
configurationBlob
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The base 64 encoded scrape configuration file.

ScraperDescription

Description

The ScraperDescription structure contains the full details about one scraper in your account.

Members
alias
Type: string

(Optional) A name associated with the scraper.

arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the scraper. For example, arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the scraper was created.

destination
Required: Yes
Type: Destination structure

The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

lastModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the scraper was last modified.

roleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

For example, arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example.

scrapeConfiguration
Required: Yes
Type: ScrapeConfiguration structure

The configuration in use by the scraper.

scraperId
Required: Yes
Type: string

The ID of the scraper. For example, s-example1-1234-abcd-5678-ef9012abcd34.

source
Required: Yes
Type: Source structure

The Amazon EKS cluster from which the scraper collects metrics.

status
Required: Yes
Type: ScraperStatus structure

A structure that contains the current status of the scraper.

statusReason
Type: string

If there is a failure, the reason for the failure.

tags
Type: Associative array of custom strings keys (TagKey) to strings

(Optional) The list of tag keys and values associated with the scraper.

ScraperStatus

Description

The ScraperStatus structure contains status information about the scraper.

Members
statusCode
Required: Yes
Type: string

The current status of the scraper.

ScraperSummary

Description

The ScraperSummary structure contains a summary of the details about one scraper in your account.

Members
alias
Type: string

(Optional) A name associated with the scraper.

arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the scraper.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the scraper was created.

destination
Required: Yes
Type: Destination structure

The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

lastModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the scraper was last modified.

roleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

scraperId
Required: Yes
Type: string

The ID of the scraper.

source
Required: Yes
Type: Source structure

The Amazon EKS cluster from which the scraper collects metrics.

status
Required: Yes
Type: ScraperStatus structure

A structure that contains the current status of the scraper.

statusReason
Type: string

If there is a failure, the reason for the failure.

tags
Type: Associative array of custom strings keys (TagKey) to strings

(Optional) The list of tag keys and values associated with the scraper.

ServiceQuotaExceededException

Description

Completing the request would cause a service quota to be exceeded.

Members
message
Required: Yes
Type: string

Description of the error.

quotaCode
Required: Yes
Type: string

Service quotas code of the originating quota.

resourceId
Required: Yes
Type: string

Identifier of the resource affected.

resourceType
Required: Yes
Type: string

Type of the resource affected.

serviceCode
Required: Yes
Type: string

Service quotas code for the originating service.

Source

Description

The source of collected metrics for a scraper.

Members
eksConfiguration
Type: EksConfiguration structure

The Amazon EKS cluster from which a scraper collects metrics.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Required: Yes
Type: string

Description of the error.

quotaCode
Type: string

Service quotas code for the originating quota.

retryAfterSeconds
Type: int

Advice to clients on when the call can be safely retried.

serviceCode
Type: string

Service quotas code for the originating service.

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members
fieldList
Type: Array of ValidationExceptionField structures

The field that caused the error, if applicable.

message
Required: Yes
Type: string

Description of the error.

reason
Required: Yes
Type: string

Reason the request failed validation.

ValidationExceptionField

Description

Information about a field passed into a request that resulted in an exception.

Members
message
Required: Yes
Type: string

A message describing why the field caused an exception.

name
Required: Yes
Type: string

The name of the field that caused an exception.

WorkspaceDescription

Description

The full details about one Amazon Managed Service for Prometheus workspace in your account.

Members
alias
Type: string

The alias that is assigned to this workspace to help identify it. It does not need to be unique.

arn
Required: Yes
Type: string

The ARN of the workspace. For example, arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the workspace was created.

kmsKeyArn
Type: string

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

prometheusEndpoint
Type: string

The Prometheus endpoint available for this workspace. For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/.

status
Required: Yes
Type: WorkspaceStatus structure

The current status of the workspace.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values that are associated with the workspace.

workspaceId
Required: Yes
Type: string

The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.

WorkspaceStatus

Description

The status of the workspace.

Members
statusCode
Required: Yes
Type: string

The current status of the workspace.

WorkspaceSummary

Description

The information about one Amazon Managed Service for Prometheus workspace in your account.

Members
alias
Type: string

The alias that is assigned to this workspace to help identify it. It does not need to be unique.

arn
Required: Yes
Type: string

The ARN of the workspace.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the workspace was created.

kmsKeyArn
Type: string

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

status
Required: Yes
Type: WorkspaceStatus structure

The current status of the workspace.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values that are associated with the workspace.

workspaceId
Required: Yes
Type: string

The unique ID for the workspace.