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

Result Syntax

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

Result Details

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 rules and alerting 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

Result Syntax

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

Result Details

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.

CreateQueryLoggingConfiguration

$result = $client->createQueryLoggingConfiguration([/* ... */]);
$promise = $client->createQueryLoggingConfigurationAsync([/* ... */]);

Creates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.

Parameter Syntax

$result = $client->createQueryLoggingConfiguration([
    'clientToken' => '<string>',
    'destinations' => [ // REQUIRED
        [
            'cloudWatchLogs' => [ // REQUIRED
                'logGroupArn' => '<string>', // REQUIRED
            ],
            'filters' => [ // REQUIRED
                'qspThreshold' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to the Amazon EKS cluster within the VPC for scraping metrics.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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 rules and alerting logging configuration for a workspace.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

DeleteQueryLoggingConfiguration

$result = $client->deleteQueryLoggingConfiguration([/* ... */]);
$promise = $client->deleteQueryLoggingConfigurationAsync([/* ... */]);

Deletes the query logging configuration for the specified workspace.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

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

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 rules and alerting logging configuration of the workspace.

Parameter Syntax

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

Parameter Details

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

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.

DescribeQueryLoggingConfiguration

$result = $client->describeQueryLoggingConfiguration([/* ... */]);
$promise = $client->describeQueryLoggingConfigurationAsync([/* ... */]);

Retrieves the details of the query logging configuration for the specified workspace.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'queryLoggingConfiguration' => [
        'createdAt' => <DateTime>,
        'destinations' => [
            [
                'cloudWatchLogs' => [
                    'logGroupArn' => '<string>',
                ],
                'filters' => [
                    'qspThreshold' => <integer>,
                ],
            ],
            // ...
        ],
        'modifiedAt' => <DateTime>,
        'status' => [
            'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED|UPDATE_FAILED',
            'statusReason' => '<string>',
        ],
        'workspace' => '<string>',
    ],
]

Result Details

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

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

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

Result Syntax

[
    'scraper' => [
        'alias' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'destination' => [
            'ampConfiguration' => [
                'workspaceArn' => '<string>',
            ],
        ],
        'lastModifiedAt' => <DateTime>,
        'roleArn' => '<string>',
        'roleConfiguration' => [
            'sourceRoleArn' => '<string>',
            'targetRoleArn' => '<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

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

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

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.

DescribeWorkspaceConfiguration

$result = $client->describeWorkspaceConfiguration([/* ... */]);
$promise = $client->describeWorkspaceConfigurationAsync([/* ... */]);

Use this operation to return information about the configuration of a workspace. The configuration details returned include workspace configuration status, label set limits, and retention period.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'workspaceConfiguration' => [
        'limitsPerLabelSet' => [
            [
                'labelSet' => ['<string>', ...],
                'limits' => [
                    'maxSeries' => <integer>,
                ],
            ],
            // ...
        ],
        'retentionPeriodInDays' => <integer>,
        'status' => [
            'statusCode' => 'ACTIVE|UPDATING|UPDATE_FAILED',
            'statusReason' => '<string>',
        ],
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

[
    'nextToken' => '<string>',
    'scrapers' => [
        [
            'alias' => '<string>',
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'destination' => [
                'ampConfiguration' => [
                    'workspaceArn' => '<string>',
                ],
            ],
            'lastModifiedAt' => <DateTime>,
            'roleArn' => '<string>',
            'roleConfiguration' => [
                'sourceRoleArn' => '<string>',
                'targetRoleArn' => '<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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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 rules and alerting logging configuration.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

UpdateQueryLoggingConfiguration

$result = $client->updateQueryLoggingConfiguration([/* ... */]);
$promise = $client->updateQueryLoggingConfigurationAsync([/* ... */]);

Updates the query logging configuration for the specified workspace.

Parameter Syntax

$result = $client->updateQueryLoggingConfiguration([
    'clientToken' => '<string>',
    'destinations' => [ // REQUIRED
        [
            'cloudWatchLogs' => [ // REQUIRED
                'logGroupArn' => '<string>', // REQUIRED
            ],
            'filters' => [ // REQUIRED
                'qspThreshold' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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
        ],
    ],
    'roleConfiguration' => [
        'sourceRoleArn' => '<string>',
        'targetRoleArn' => '<string>',
    ],
    'scrapeConfiguration' => [
        'configurationBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'scraperId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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.

UpdateWorkspaceConfiguration

$result = $client->updateWorkspaceConfiguration([/* ... */]);
$promise = $client->updateWorkspaceConfigurationAsync([/* ... */]);

Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the request to be valid.

Parameter Syntax

$result = $client->updateWorkspaceConfiguration([
    'clientToken' => '<string>',
    'limitsPerLabelSet' => [
        [
            'labelSet' => ['<string>', ...], // REQUIRED
            'limits' => [ // REQUIRED
                'maxSeries' => <integer>,
            ],
        ],
        // ...
    ],
    'retentionPeriodInDays' => <integer>,
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.