Amazon Prometheus Service 2020-08-01
- 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 */).
- CreateWorkspace ( array $params = [] )
Creates a new AMP workspace.
- DeleteWorkspace ( array $params = [] )
Deletes an AMP workspace.
- DescribeWorkspace ( array $params = [] )
Describes an existing AMP workspace.
- ListWorkspaces ( array $params = [] )
Lists all AMP workspaces, including workspaces being created or deleted.
- UpdateWorkspaceAlias ( array $params = [] )
Updates an AMP workspace alias.
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:
Operations
CreateWorkspace
$result = $client->createWorkspace([/* ... */]); $promise = $client->createWorkspaceAsync([/* ... */]);
Creates a new AMP workspace.
Parameter Syntax
$result = $client->createWorkspace([
'alias' => '<string>',
'clientToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'arn' => '<string>',
'status' => [
'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED',
],
'workspaceId' => '<string>',
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the workspace that was just created.
- status
-
- Required: Yes
- Type: WorkspaceStatus structure
The status of the workspace that was just created (usually CREATING).
- workspaceId
-
- Required: Yes
- Type: string
The generated ID of the workspace that was just created.
Errors
-
Request was denied due to request throttling.
-
Updating or deleting a resource can cause an inconsistent state.
-
The input fails to satisfy the constraints specified by an AWS service.
-
User does not have sufficient access to perform this action.
-
Unexpected error during processing of request.
-
ServiceQuotaExceededException:
Request would cause a service quota to be exceeded.
DeleteWorkspace
$result = $client->deleteWorkspace([/* ... */]); $promise = $client->deleteWorkspaceAsync([/* ... */]);
Deletes an AMP workspace.
Parameter Syntax
$result = $client->deleteWorkspace([
'clientToken' => '<string>',
'workspaceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
Request references a resource which does not exist.
-
User does not have sufficient access to perform this action.
-
Unexpected error during processing of request.
DescribeWorkspace
$result = $client->describeWorkspace([/* ... */]); $promise = $client->describeWorkspaceAsync([/* ... */]);
Describes an existing AMP workspace.
Parameter Syntax
$result = $client->describeWorkspace([
'workspaceId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'workspace' => [
'alias' => '<string>',
'arn' => '<string>',
'createdAt' => <DateTime>,
'prometheusEndpoint' => '<string>',
'status' => [
'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED',
],
'workspaceId' => '<string>',
],
]
Result Details
Members
- workspace
-
- Required: Yes
- Type: WorkspaceDescription structure
The properties of the selected workspace.
Errors
-
Request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
Request references a resource which does not exist.
-
User does not have sufficient access to perform this action.
-
Unexpected error during processing of request.
ListWorkspaces
$result = $client->listWorkspaces([/* ... */]); $promise = $client->listWorkspacesAsync([/* ... */]);
Lists all AMP workspaces, including workspaces being created or deleted.
Parameter Syntax
$result = $client->listWorkspaces([
'alias' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- alias
-
- Type: string
Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
- maxResults
-
- Type: int
Maximum results to return in response (default=100, maximum=1000).
- nextToken
-
- Type: string
Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.
Result Syntax
[
'nextToken' => '<string>',
'workspaces' => [
[
'alias' => '<string>',
'arn' => '<string>',
'createdAt' => <DateTime>,
'status' => [
'statusCode' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATION_FAILED',
],
'workspaceId' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token to use when requesting the next page in this list.
- workspaces
-
- Required: Yes
- Type: Array of WorkspaceSummary structures
The list of existing workspaces, including those undergoing creation or deletion.
Errors
-
Request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
User does not have sufficient access to perform this action.
-
Unexpected error during processing of request.
UpdateWorkspaceAlias
$result = $client->updateWorkspaceAlias([/* ... */]); $promise = $client->updateWorkspaceAliasAsync([/* ... */]);
Updates an AMP workspace alias.
Parameter Syntax
$result = $client->updateWorkspaceAlias([
'alias' => '<string>',
'clientToken' => '<string>',
'workspaceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Request was denied due to request throttling.
-
Updating or deleting a resource can cause an inconsistent state.
-
The input fails to satisfy the constraints specified by an AWS service.
-
Request references a resource which does not exist.
-
User does not have sufficient access to perform this action.
-
Unexpected error during processing of request.
-
ServiceQuotaExceededException:
Request would cause a service quota to be exceeded.
Shapes
AccessDeniedException
Description
User does not have sufficient access to perform this action.
Members
ConflictException
Description
Updating or deleting a resource can cause an inconsistent state.
Members
InternalServerException
Description
Unexpected error during processing of request.
Members
ResourceNotFoundException
Description
Request references a resource which does not exist.
Members
ServiceQuotaExceededException
Description
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 requirement to identify 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 requirement to identify originating service.
ThrottlingException
Description
Request was denied due to request throttling.
Members
- message
-
- Required: Yes
- Type: string
Description of the error.
- quotaCode
-
- Type: string
Service Quotas requirement to identify originating quota.
- retryAfterSeconds
-
- Type: int
Advice to clients on when the call can be safely retried.
- serviceCode
-
- Type: string
Service Quotas requirement to identify originating service.
ValidationException
Description
The input fails to satisfy the constraints specified by an AWS service.
Members
- fieldList
-
- Type: Array of ValidationExceptionField structures
The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message.
- message
-
- Required: Yes
- Type: string
Description of the error.
- reason
-
- Required: Yes
- Type: string
Reason the request failed validation.
ValidationExceptionField
Description
Stores information about a field passed inside a request that resulted in an exception.
Members
WorkspaceDescription
Description
Represents the properties of a workspace.
Members
- alias
-
- Type: string
Alias of this workspace.
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of this workspace.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the workspace was created.
- prometheusEndpoint
-
- Type: string
Prometheus endpoint URI.
- status
-
- Required: Yes
- Type: WorkspaceStatus structure
The status of this workspace.
- workspaceId
-
- Required: Yes
- Type: string
Unique string identifying this workspace.
WorkspaceStatus
Description
Represents the status of a workspace.
Members
WorkspaceSummary
Description
Represents a summary of the properties of a workspace.
Members
- alias
-
- Type: string
Alias of this workspace.
- arn
-
- Required: Yes
- Type: string
The AmazonResourceName of this workspace.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the workspace was created.
- status
-
- Required: Yes
- Type: WorkspaceStatus structure
The status of this workspace.
- workspaceId
-
- Required: Yes
- Type: string
Unique string identifying this workspace.