SDK for PHP 3.x

CloudWatch Observability Admin Service 2018-05-10

Client: Aws\ObservabilityAdmin\ObservabilityAdminClient
Service ID: observabilityadmin
Version: 2018-05-10

This page describes the parameters and results for the operations of the CloudWatch Observability Admin Service (2018-05-10), and shows how to use the Aws\ObservabilityAdmin\ObservabilityAdminClient object to call the described operations. This documentation is specific to the 2018-05-10 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 */).

GetTelemetryEvaluationStatus ( array $params = [] )
Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.
GetTelemetryEvaluationStatusForOrganization ( array $params = [] )
This returns the onboarding status of the telemetry configuration feature for the organization.
ListResourceTelemetry ( array $params = [] )
Returns a list of telemetry configurations for AWS resources supported by telemetry config.
ListResourceTelemetryForOrganization ( array $params = [] )
Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.
StartTelemetryEvaluation ( array $params = [] )
This action begins onboarding onboarding the caller AWS account to the telemetry config feature.
StartTelemetryEvaluationForOrganization ( array $params = [] )
This actions begins onboarding the organization and all member accounts to the telemetry config feature.
StopTelemetryEvaluation ( array $params = [] )
This action begins offboarding the caller AWS account from the telemetry config feature.
StopTelemetryEvaluationForOrganization ( array $params = [] )
This action offboards the Organization of the caller AWS account from thef telemetry config feature.

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:

ListResourceTelemetry
ListResourceTelemetryForOrganization

Operations

GetTelemetryEvaluationStatus 

$result = $client->getTelemetryEvaluationStatus([/* ... */]);
$promise = $client->getTelemetryEvaluationStatusAsync([/* ... */]);

Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'FailureReason' => '<string>',
    'Status' => 'NOT_STARTED|STARTING|FAILED_START|RUNNING|STOPPING|FAILED_STOP|STOPPED',
]

Result Details

Members
FailureReason
Type: string

Describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.

Status
Type: string

The onboarding status of the telemetry config feature.

Errors

AccessDeniedException:

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

InternalServerException:

Indicates the request has failed to process because of an unknown server error, exception, or failure.

GetTelemetryEvaluationStatusForOrganization 

$result = $client->getTelemetryEvaluationStatusForOrganization([/* ... */]);
$promise = $client->getTelemetryEvaluationStatusForOrganizationAsync([/* ... */]);

This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an AWS Organization or an assigned Delegated Admin Account of AWS CloudWatch telemetry config.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'FailureReason' => '<string>',
    'Status' => 'NOT_STARTED|STARTING|FAILED_START|RUNNING|STOPPING|FAILED_STOP|STOPPED',
]

Result Details

Members
FailureReason
Type: string

This field describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.

Status
Type: string

The onboarding status of the telemetry config feature for the organization.

Errors

AccessDeniedException:

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

InternalServerException:

Indicates the request has failed to process because of an unknown server error, exception, or failure.

ValidationException:

Indicates input validation failed. Check your request parameters and retry the request.

ListResourceTelemetry 

$result = $client->listResourceTelemetry([/* ... */]);
$promise = $client->listResourceTelemetryAsync([/* ... */]);

Returns a list of telemetry configurations for AWS resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.

Parameter Syntax

$result = $client->listResourceTelemetry([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceIdentifierPrefix' => '<string>',
    'ResourceTags' => ['<string>', ...],
    'ResourceTypes' => ['<string>', ...],
    'TelemetryConfigurationState' => ['<string>', ...],
]);

Parameter Details

Members
MaxResults
Type: int

A number field used to limit the number of results within the returned list.

NextToken
Type: string

The token for the next set of items to return. A previous call generates this token.

ResourceIdentifierPrefix
Type: string

A string used to filter resources which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.

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

A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags?

ResourceTypes
Type: Array of strings

A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the resources will be returned in the same order used in the request.

TelemetryConfigurationState
Type: Associative array of custom strings keys (TelemetryType) to strings

A key-value pair to filter resources based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.

Result Syntax

[
    'NextToken' => '<string>',
    'TelemetryConfigurations' => [
        [
            'AccountIdentifier' => '<string>',
            'LastUpdateTimeStamp' => <integer>,
            'ResourceIdentifier' => '<string>',
            'ResourceTags' => ['<string>', ...],
            'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function',
            'TelemetryConfigurationState' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token for the next set of items to return. A previous call generates this token.

TelemetryConfigurations
Type: Array of TelemetryConfiguration structures

A list of telemetry configurations for AWS resources supported by telemetry config in the caller's account.

Errors

AccessDeniedException:

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

InternalServerException:

Indicates the request has failed to process because of an unknown server error, exception, or failure.

ValidationException:

Indicates input validation failed. Check your request parameters and retry the request.

ListResourceTelemetryForOrganization 

$result = $client->listResourceTelemetryForOrganization([/* ... */]);
$promise = $client->listResourceTelemetryForOrganizationAsync([/* ... */]);

Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.

Parameter Syntax

$result = $client->listResourceTelemetryForOrganization([
    'AccountIdentifiers' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceIdentifierPrefix' => '<string>',
    'ResourceTags' => ['<string>', ...],
    'ResourceTypes' => ['<string>', ...],
    'TelemetryConfigurationState' => ['<string>', ...],
]);

Parameter Details

Members
AccountIdentifiers
Type: Array of strings

A list of AWS account IDs used to filter the resources to those associated with the specified accounts.

MaxResults
Type: int

A number field used to limit the number of results within the returned list.

NextToken
Type: string

The token for the next set of items to return. A previous call provides this token.

ResourceIdentifierPrefix
Type: string

A string used to filter resources in the organization which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.

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

A key-value pair to filter resources in the organization based on tags associated with the resource. Fore more information about tags, see What are tags?

ResourceTypes
Type: Array of strings

A list of resource types used to filter resources in the organization. If this parameter is provided, the resources will be returned in the same order used in the request.

TelemetryConfigurationState
Type: Associative array of custom strings keys (TelemetryType) to strings

A key-value pair to filter resources in the organization based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.

Result Syntax

[
    'NextToken' => '<string>',
    'TelemetryConfigurations' => [
        [
            'AccountIdentifier' => '<string>',
            'LastUpdateTimeStamp' => <integer>,
            'ResourceIdentifier' => '<string>',
            'ResourceTags' => ['<string>', ...],
            'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function',
            'TelemetryConfigurationState' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token for the next set of items to return. A previous call provides this token.

TelemetryConfigurations
Type: Array of TelemetryConfiguration structures

A list of telemetry configurations for AWS resources supported by telemetry config in the organization.

Errors

AccessDeniedException:

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

InternalServerException:

Indicates the request has failed to process because of an unknown server error, exception, or failure.

ValidationException:

Indicates input validation failed. Check your request parameters and retry the request.

StartTelemetryEvaluation 

$result = $client->startTelemetryEvaluation([/* ... */]);
$promise = $client->startTelemetryEvaluationAsync([/* ... */]);

This action begins onboarding onboarding the caller AWS account to the telemetry config feature.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

InternalServerException:

Indicates the request has failed to process because of an unknown server error, exception, or failure.

ValidationException:

Indicates input validation failed. Check your request parameters and retry the request.

StartTelemetryEvaluationForOrganization 

$result = $client->startTelemetryEvaluationForOrganization([/* ... */]);
$promise = $client->startTelemetryEvaluationForOrganizationAsync([/* ... */]);

This actions begins onboarding the organization and all member accounts to the telemetry config feature.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

InternalServerException:

Indicates the request has failed to process because of an unknown server error, exception, or failure.

ValidationException:

Indicates input validation failed. Check your request parameters and retry the request.

StopTelemetryEvaluation 

$result = $client->stopTelemetryEvaluation([/* ... */]);
$promise = $client->stopTelemetryEvaluationAsync([/* ... */]);

This action begins offboarding the caller AWS account from the telemetry config feature.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

InternalServerException:

Indicates the request has failed to process because of an unknown server error, exception, or failure.

ValidationException:

Indicates input validation failed. Check your request parameters and retry the request.

StopTelemetryEvaluationForOrganization 

$result = $client->stopTelemetryEvaluationForOrganization([/* ... */]);
$promise = $client->stopTelemetryEvaluationForOrganizationAsync([/* ... */]);

This action offboards the Organization of the caller AWS account from thef telemetry config feature.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

InternalServerException:

Indicates the request has failed to process because of an unknown server error, exception, or failure.

ValidationException:

Indicates input validation failed. Check your request parameters and retry the request.

Shapes

AccessDeniedException

Description

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

Members
Message
Type: string
amznErrorType
Type: string

The name of the exception.

InternalServerException

Description

Indicates the request has failed to process because of an unknown server error, exception, or failure.

Members
Message
Type: string
amznErrorType
Type: string

The name of the exception.

TelemetryConfiguration

Description

A model representing the state of a resource within an account according to telemetry config.

Members
AccountIdentifier
Type: string

The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is 012345678901.

LastUpdateTimeStamp
Type: long (int|float)

The timestamp of the last change to the telemetry configuration for the resource. For example, 1728679196318.

ResourceIdentifier
Type: string

The identifier of the resource, for example i-0b22a22eec53b9321.

ResourceTags
Type: Associative array of custom strings keys (String) to strings

Tags associated with the resource, for example { Name: "ExampleInstance", Environment: "Development" }.

ResourceType
Type: string

The type of resource, for example AWS::EC2::Instance.

TelemetryConfigurationState
Type: Associative array of custom strings keys (TelemetryType) to strings

The configuration state for the resource, for example { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }.

ValidationException

Description

Indicates input validation failed. Check your request parameters and retry the request.

Members
Message
Type: string