CreateCentralizationRuleForOrganization

$result = $client->createCentralizationRuleForOrganization([/* ... */]);
$promise = $client->createCentralizationRuleForOrganizationAsync([/* ... */]);

Creates a centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

$result = $client->createCentralizationRuleForOrganization([
    'Rule' => [ // REQUIRED
        'Destination' => [ // REQUIRED
            'Account' => '<string>',
            'DestinationLogsConfiguration' => [
                'BackupConfiguration' => [
                    'KmsKeyArn' => '<string>',
                    'Region' => '<string>', // REQUIRED
                ],
                'LogsEncryptionConfiguration' => [
                    'EncryptionConflictResolutionStrategy' => 'ALLOW|SKIP',
                    'EncryptionStrategy' => 'CUSTOMER_MANAGED|AWS_OWNED', // REQUIRED
                    'KmsKeyArn' => '<string>',
                ],
            ],
            'Region' => '<string>', // REQUIRED
        ],
        'Source' => [ // REQUIRED
            'Regions' => ['<string>', ...], // REQUIRED
            'Scope' => '<string>',
            'SourceLogsConfiguration' => [
                'EncryptedLogGroupStrategy' => 'ALLOW|SKIP', // REQUIRED
                'LogGroupSelectionCriteria' => '<string>', // REQUIRED
            ],
        ],
    ],
    'RuleName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'RuleArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

ConflictException:

The requested operation conflicts with the current state of the specified resource or with another request.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

CreateS3TableIntegration

$result = $client->createS3TableIntegration([/* ... */]);
$promise = $client->createS3TableIntegrationAsync([/* ... */]);

Creates an integration between CloudWatch and S3 Tables for analytics. This integration enables querying CloudWatch telemetry data using analytics engines like Amazon Athena, Amazon Redshift, and Apache Spark.

Parameter Syntax

$result = $client->createS3TableIntegration([
    'Encryption' => [ // REQUIRED
        'KmsKeyArn' => '<string>',
        'SseAlgorithm' => 'aws:kms|AES256', // REQUIRED
    ],
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

ConflictException:

The requested operation conflicts with the current state of the specified resource or with another request.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

CreateTelemetryPipeline

$result = $client->createTelemetryPipeline([/* ... */]);
$promise = $client->createTelemetryPipelineAsync([/* ... */]);

Creates a telemetry pipeline for processing and transforming telemetry data. The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities.

Parameter Syntax

$result = $client->createTelemetryPipeline([
    'Configuration' => [ // REQUIRED
        'Body' => '<string>', // REQUIRED
    ],
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

ConflictException:

The requested operation conflicts with the current state of the specified resource or with another request.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

CreateTelemetryRule

$result = $client->createTelemetryRule([/* ... */]);
$promise = $client->createTelemetryRuleAsync([/* ... */]);

Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

Parameter Syntax

$result = $client->createTelemetryRule([
    'Rule' => [ // REQUIRED
        'DestinationConfiguration' => [
            'CloudtrailParameters' => [
                'AdvancedEventSelectors' => [ // REQUIRED
                    [
                        'FieldSelectors' => [ // REQUIRED
                            [
                                'EndsWith' => ['<string>', ...],
                                'Equals' => ['<string>', ...],
                                'Field' => '<string>', // REQUIRED
                                'NotEndsWith' => ['<string>', ...],
                                'NotEquals' => ['<string>', ...],
                                'NotStartsWith' => ['<string>', ...],
                                'StartsWith' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DestinationPattern' => '<string>',
            'DestinationType' => 'cloud-watch-logs',
            'ELBLoadBalancerLoggingParameters' => [
                'FieldDelimiter' => '<string>',
                'OutputFormat' => 'plain|json',
            ],
            'LogDeliveryParameters' => [
                'LogTypes' => ['<string>', ...],
            ],
            'RetentionInDays' => <integer>,
            'VPCFlowLogParameters' => [
                'LogFormat' => '<string>',
                'MaxAggregationInterval' => <integer>,
                'TrafficType' => '<string>',
            ],
            'WAFLoggingParameters' => [
                'LogType' => 'WAF_LOGS',
                'LoggingFilter' => [
                    'DefaultBehavior' => 'KEEP|DROP',
                    'Filters' => [
                        [
                            'Behavior' => 'KEEP|DROP',
                            'Conditions' => [
                                [
                                    'ActionCondition' => [
                                        'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT',
                                    ],
                                    'LabelNameCondition' => [
                                        'LabelName' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'Requirement' => 'MEETS_ALL|MEETS_ANY',
                        ],
                        // ...
                    ],
                ],
                'RedactedFields' => [
                    [
                        'Method' => '<string>',
                        'QueryString' => '<string>',
                        'SingleHeader' => [
                            'Name' => '<string>',
                        ],
                        'UriPath' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
        'Scope' => '<string>',
        'SelectionCriteria' => '<string>',
        'TelemetrySourceTypes' => ['<string>', ...],
        'TelemetryType' => 'Logs|Metrics|Traces', // REQUIRED
    ],
    'RuleName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'RuleArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

ConflictException:

The requested operation conflicts with the current state of the specified resource or with another request.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

CreateTelemetryRuleForOrganization

$result = $client->createTelemetryRuleForOrganization([/* ... */]);
$promise = $client->createTelemetryRuleForOrganizationAsync([/* ... */]);

Creates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

$result = $client->createTelemetryRuleForOrganization([
    'Rule' => [ // REQUIRED
        'DestinationConfiguration' => [
            'CloudtrailParameters' => [
                'AdvancedEventSelectors' => [ // REQUIRED
                    [
                        'FieldSelectors' => [ // REQUIRED
                            [
                                'EndsWith' => ['<string>', ...],
                                'Equals' => ['<string>', ...],
                                'Field' => '<string>', // REQUIRED
                                'NotEndsWith' => ['<string>', ...],
                                'NotEquals' => ['<string>', ...],
                                'NotStartsWith' => ['<string>', ...],
                                'StartsWith' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DestinationPattern' => '<string>',
            'DestinationType' => 'cloud-watch-logs',
            'ELBLoadBalancerLoggingParameters' => [
                'FieldDelimiter' => '<string>',
                'OutputFormat' => 'plain|json',
            ],
            'LogDeliveryParameters' => [
                'LogTypes' => ['<string>', ...],
            ],
            'RetentionInDays' => <integer>,
            'VPCFlowLogParameters' => [
                'LogFormat' => '<string>',
                'MaxAggregationInterval' => <integer>,
                'TrafficType' => '<string>',
            ],
            'WAFLoggingParameters' => [
                'LogType' => 'WAF_LOGS',
                'LoggingFilter' => [
                    'DefaultBehavior' => 'KEEP|DROP',
                    'Filters' => [
                        [
                            'Behavior' => 'KEEP|DROP',
                            'Conditions' => [
                                [
                                    'ActionCondition' => [
                                        'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT',
                                    ],
                                    'LabelNameCondition' => [
                                        'LabelName' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'Requirement' => 'MEETS_ALL|MEETS_ANY',
                        ],
                        // ...
                    ],
                ],
                'RedactedFields' => [
                    [
                        'Method' => '<string>',
                        'QueryString' => '<string>',
                        'SingleHeader' => [
                            'Name' => '<string>',
                        ],
                        'UriPath' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
        'Scope' => '<string>',
        'SelectionCriteria' => '<string>',
        'TelemetrySourceTypes' => ['<string>', ...],
        'TelemetryType' => 'Logs|Metrics|Traces', // REQUIRED
    ],
    'RuleName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'RuleArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

ConflictException:

The requested operation conflicts with the current state of the specified resource or with another request.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

DeleteCentralizationRuleForOrganization

$result = $client->deleteCentralizationRuleForOrganization([/* ... */]);
$promise = $client->deleteCentralizationRuleForOrganizationAsync([/* ... */]);

Deletes an organization-wide centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

DeleteS3TableIntegration

$result = $client->deleteS3TableIntegration([/* ... */]);
$promise = $client->deleteS3TableIntegrationAsync([/* ... */]);

Deletes an S3 Table integration and its associated data. This operation removes the connection between CloudWatch Observability Admin and S3 Tables.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

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 Amazon Web Services resources in the IAM user guide.

InternalServerException:

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

InvalidStateException:

The requested operation cannot be completed on the specified resource in the current state.

ValidationException:

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

TooManyRequestsException:

The request throughput limit was exceeded.

DeleteTelemetryPipeline

$result = $client->deleteTelemetryPipeline([/* ... */]);
$promise = $client->deleteTelemetryPipelineAsync([/* ... */]);

Deletes a telemetry pipeline and its associated resources. This operation stops data processing and removes the pipeline configuration.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

ConflictException:

The requested operation conflicts with the current state of the specified resource or with another request.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

DeleteTelemetryRule

$result = $client->deleteTelemetryRule([/* ... */]);
$promise = $client->deleteTelemetryRuleAsync([/* ... */]);

Deletes a telemetry rule from your account. Any telemetry configurations previously created by the rule will remain but no new resources will be configured by this rule.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

DeleteTelemetryRuleForOrganization

$result = $client->deleteTelemetryRuleForOrganization([/* ... */]);
$promise = $client->deleteTelemetryRuleForOrganizationAsync([/* ... */]);

Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

GetCentralizationRuleForOrganization

$result = $client->getCentralizationRuleForOrganization([/* ... */]);
$promise = $client->getCentralizationRuleForOrganizationAsync([/* ... */]);

Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CentralizationRule' => [
        'Destination' => [
            'Account' => '<string>',
            'DestinationLogsConfiguration' => [
                'BackupConfiguration' => [
                    'KmsKeyArn' => '<string>',
                    'Region' => '<string>',
                ],
                'LogsEncryptionConfiguration' => [
                    'EncryptionConflictResolutionStrategy' => 'ALLOW|SKIP',
                    'EncryptionStrategy' => 'CUSTOMER_MANAGED|AWS_OWNED',
                    'KmsKeyArn' => '<string>',
                ],
            ],
            'Region' => '<string>',
        ],
        'Source' => [
            'Regions' => ['<string>', ...],
            'Scope' => '<string>',
            'SourceLogsConfiguration' => [
                'EncryptedLogGroupStrategy' => 'ALLOW|SKIP',
                'LogGroupSelectionCriteria' => '<string>',
            ],
        ],
    ],
    'CreatedRegion' => '<string>',
    'CreatedTimeStamp' => <integer>,
    'CreatorAccountId' => '<string>',
    'FailureReason' => 'TRUSTED_ACCESS_NOT_ENABLED|DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION|INTERNAL_SERVER_ERROR',
    'LastUpdateTimeStamp' => <integer>,
    'RuleArn' => '<string>',
    'RuleHealth' => 'Healthy|Unhealthy|Provisioning',
    'RuleName' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

GetS3TableIntegration

$result = $client->getS3TableIntegration([/* ... */]);
$promise = $client->getS3TableIntegrationAsync([/* ... */]);

Retrieves information about a specific S3 Table integration, including its configuration, status, and metadata.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreatedTimeStamp' => <integer>,
    'DestinationTableBucketArn' => '<string>',
    'Encryption' => [
        'KmsKeyArn' => '<string>',
        'SseAlgorithm' => 'aws:kms|AES256',
    ],
    'RoleArn' => '<string>',
    'Status' => 'ACTIVE|DELETING',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

GetTelemetryEnrichmentStatus

$result = $client->getTelemetryEnrichmentStatus([/* ... */]);
$promise = $client->getTelemetryEnrichmentStatusAsync([/* ... */]);

Returns the current status of the resource tags for telemetry feature, which enhances telemetry data with additional resource metadata from Resource Explorer.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AwsResourceExplorerManagedViewArn' => '<string>',
    'Status' => 'Running|Stopped|Impaired',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services resources in the IAM user guide.

InternalServerException:

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

TooManyRequestsException:

The request throughput limit was exceeded.

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

Result Syntax

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

Result Details

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 Amazon Web Services resources in the IAM user guide.

InternalServerException:

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

TooManyRequestsException:

The request throughput limit was exceeded.

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 Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

GetTelemetryPipeline

$result = $client->getTelemetryPipeline([/* ... */]);
$promise = $client->getTelemetryPipelineAsync([/* ... */]);

Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Pipeline' => [
        'Arn' => '<string>',
        'Configuration' => [
            'Body' => '<string>',
        ],
        'CreatedTimeStamp' => <integer>,
        'LastUpdateTimeStamp' => <integer>,
        'Name' => '<string>',
        'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED',
        'StatusReason' => [
            'Description' => '<string>',
        ],
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

GetTelemetryRule

$result = $client->getTelemetryRule([/* ... */]);
$promise = $client->getTelemetryRuleAsync([/* ... */]);

Retrieves the details of a specific telemetry rule in your account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedTimeStamp' => <integer>,
    'LastUpdateTimeStamp' => <integer>,
    'RuleArn' => '<string>',
    'RuleName' => '<string>',
    'TelemetryRule' => [
        'DestinationConfiguration' => [
            'CloudtrailParameters' => [
                'AdvancedEventSelectors' => [
                    [
                        'FieldSelectors' => [
                            [
                                'EndsWith' => ['<string>', ...],
                                'Equals' => ['<string>', ...],
                                'Field' => '<string>',
                                'NotEndsWith' => ['<string>', ...],
                                'NotEquals' => ['<string>', ...],
                                'NotStartsWith' => ['<string>', ...],
                                'StartsWith' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DestinationPattern' => '<string>',
            'DestinationType' => 'cloud-watch-logs',
            'ELBLoadBalancerLoggingParameters' => [
                'FieldDelimiter' => '<string>',
                'OutputFormat' => 'plain|json',
            ],
            'LogDeliveryParameters' => [
                'LogTypes' => ['<string>', ...],
            ],
            'RetentionInDays' => <integer>,
            'VPCFlowLogParameters' => [
                'LogFormat' => '<string>',
                'MaxAggregationInterval' => <integer>,
                'TrafficType' => '<string>',
            ],
            'WAFLoggingParameters' => [
                'LogType' => 'WAF_LOGS',
                'LoggingFilter' => [
                    'DefaultBehavior' => 'KEEP|DROP',
                    'Filters' => [
                        [
                            'Behavior' => 'KEEP|DROP',
                            'Conditions' => [
                                [
                                    'ActionCondition' => [
                                        'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT',
                                    ],
                                    'LabelNameCondition' => [
                                        'LabelName' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'Requirement' => 'MEETS_ALL|MEETS_ANY',
                        ],
                        // ...
                    ],
                ],
                'RedactedFields' => [
                    [
                        'Method' => '<string>',
                        'QueryString' => '<string>',
                        'SingleHeader' => [
                            'Name' => '<string>',
                        ],
                        'UriPath' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
        'Scope' => '<string>',
        'SelectionCriteria' => '<string>',
        'TelemetrySourceTypes' => ['<string>', ...],
        'TelemetryType' => 'Logs|Metrics|Traces',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

GetTelemetryRuleForOrganization

$result = $client->getTelemetryRuleForOrganization([/* ... */]);
$promise = $client->getTelemetryRuleForOrganizationAsync([/* ... */]);

Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedTimeStamp' => <integer>,
    'LastUpdateTimeStamp' => <integer>,
    'RuleArn' => '<string>',
    'RuleName' => '<string>',
    'TelemetryRule' => [
        'DestinationConfiguration' => [
            'CloudtrailParameters' => [
                'AdvancedEventSelectors' => [
                    [
                        'FieldSelectors' => [
                            [
                                'EndsWith' => ['<string>', ...],
                                'Equals' => ['<string>', ...],
                                'Field' => '<string>',
                                'NotEndsWith' => ['<string>', ...],
                                'NotEquals' => ['<string>', ...],
                                'NotStartsWith' => ['<string>', ...],
                                'StartsWith' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DestinationPattern' => '<string>',
            'DestinationType' => 'cloud-watch-logs',
            'ELBLoadBalancerLoggingParameters' => [
                'FieldDelimiter' => '<string>',
                'OutputFormat' => 'plain|json',
            ],
            'LogDeliveryParameters' => [
                'LogTypes' => ['<string>', ...],
            ],
            'RetentionInDays' => <integer>,
            'VPCFlowLogParameters' => [
                'LogFormat' => '<string>',
                'MaxAggregationInterval' => <integer>,
                'TrafficType' => '<string>',
            ],
            'WAFLoggingParameters' => [
                'LogType' => 'WAF_LOGS',
                'LoggingFilter' => [
                    'DefaultBehavior' => 'KEEP|DROP',
                    'Filters' => [
                        [
                            'Behavior' => 'KEEP|DROP',
                            'Conditions' => [
                                [
                                    'ActionCondition' => [
                                        'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT',
                                    ],
                                    'LabelNameCondition' => [
                                        'LabelName' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'Requirement' => 'MEETS_ALL|MEETS_ANY',
                        ],
                        // ...
                    ],
                ],
                'RedactedFields' => [
                    [
                        'Method' => '<string>',
                        'QueryString' => '<string>',
                        'SingleHeader' => [
                            'Name' => '<string>',
                        ],
                        'UriPath' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
        'Scope' => '<string>',
        'SelectionCriteria' => '<string>',
        'TelemetrySourceTypes' => ['<string>', ...],
        'TelemetryType' => 'Logs|Metrics|Traces',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

ListCentralizationRulesForOrganization

$result = $client->listCentralizationRulesForOrganization([/* ... */]);
$promise = $client->listCentralizationRulesForOrganizationAsync([/* ... */]);

Lists all centralization rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

$result = $client->listCentralizationRulesForOrganization([
    'AllRegions' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RuleNamePrefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CentralizationRuleSummaries' => [
        [
            'CreatedRegion' => '<string>',
            'CreatedTimeStamp' => <integer>,
            'CreatorAccountId' => '<string>',
            'DestinationAccountId' => '<string>',
            'DestinationRegion' => '<string>',
            'FailureReason' => 'TRUSTED_ACCESS_NOT_ENABLED|DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION|INTERNAL_SERVER_ERROR',
            'LastUpdateTimeStamp' => <integer>,
            'RuleArn' => '<string>',
            'RuleHealth' => 'Healthy|Unhealthy|Provisioning',
            'RuleName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

ListResourceTelemetry

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

Returns a list of telemetry configurations for Amazon Web Services 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

Result Syntax

[
    'NextToken' => '<string>',
    'TelemetryConfigurations' => [
        [
            'AccountIdentifier' => '<string>',
            'LastUpdateTimeStamp' => <integer>,
            'ResourceIdentifier' => '<string>',
            'ResourceTags' => ['<string>', ...],
            'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
            'TelemetryConfigurationState' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

ListResourceTelemetryForOrganization

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

Returns a list of telemetry configurations for Amazon Web Services 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

Result Syntax

[
    'NextToken' => '<string>',
    'TelemetryConfigurations' => [
        [
            'AccountIdentifier' => '<string>',
            'LastUpdateTimeStamp' => <integer>,
            'ResourceIdentifier' => '<string>',
            'ResourceTags' => ['<string>', ...],
            'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
            'TelemetryConfigurationState' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

ListS3TableIntegrations

$result = $client->listS3TableIntegrations([/* ... */]);
$promise = $client->listS3TableIntegrationsAsync([/* ... */]);

Lists all S3 Table integrations in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameter Syntax

$result = $client->listS3TableIntegrations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'IntegrationSummaries' => [
        [
            'Arn' => '<string>',
            'Status' => 'ACTIVE|DELETING',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

ListTagsForResource

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

Lists all tags attached to the specified resource. Supports telemetry rule resources and telemetry pipeline resources.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

ListTelemetryPipelines

$result = $client->listTelemetryPipelines([/* ... */]);
$promise = $client->listTelemetryPipelinesAsync([/* ... */]);

Returns a list of telemetry pipelines in your account. Returns up to 100 results. If more than 100 telemetry pipelines exist, include the NextToken value from the response to retrieve the next set of results.

Parameter Syntax

$result = $client->listTelemetryPipelines([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PipelineSummaries' => [
        [
            'Arn' => '<string>',
            'ConfigurationSummary' => [
                'DataSources' => [
                    [
                        'Name' => '<string>',
                        'Type' => '<string>',
                    ],
                    // ...
                ],
                'ProcessorCount' => <integer>,
                'Processors' => ['<string>', ...],
                'Sinks' => ['<string>', ...],
                'Sources' => [
                    [
                        'Type' => '<string>',
                    ],
                    // ...
                ],
            ],
            'CreatedTimeStamp' => <integer>,
            'LastUpdateTimeStamp' => <integer>,
            'Name' => '<string>',
            'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

ListTelemetryRules

$result = $client->listTelemetryRules([/* ... */]);
$promise = $client->listTelemetryRulesAsync([/* ... */]);

Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.

Parameter Syntax

$result = $client->listTelemetryRules([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RuleNamePrefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TelemetryRuleSummaries' => [
        [
            'CreatedTimeStamp' => <integer>,
            'LastUpdateTimeStamp' => <integer>,
            'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
            'RuleArn' => '<string>',
            'RuleName' => '<string>',
            'TelemetrySourceTypes' => ['<string>', ...],
            'TelemetryType' => 'Logs|Metrics|Traces',
        ],
        // ...
    ],
]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

ListTelemetryRulesForOrganization

$result = $client->listTelemetryRulesForOrganization([/* ... */]);
$promise = $client->listTelemetryRulesForOrganizationAsync([/* ... */]);

Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

$result = $client->listTelemetryRulesForOrganization([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RuleNamePrefix' => '<string>',
    'SourceAccountIds' => ['<string>', ...],
    'SourceOrganizationUnitIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TelemetryRuleSummaries' => [
        [
            'CreatedTimeStamp' => <integer>,
            'LastUpdateTimeStamp' => <integer>,
            'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
            'RuleArn' => '<string>',
            'RuleName' => '<string>',
            'TelemetrySourceTypes' => ['<string>', ...],
            'TelemetryType' => 'Logs|Metrics|Traces',
        ],
        // ...
    ],
]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

StartTelemetryEnrichment

$result = $client->startTelemetryEnrichment([/* ... */]);
$promise = $client->startTelemetryEnrichmentAsync([/* ... */]);

Enables the resource tags for telemetry feature for your account, which enhances telemetry data with additional resource metadata from Resource Explorer to provide richer context for monitoring and observability.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AwsResourceExplorerManagedViewArn' => '<string>',
    'Status' => 'Running|Stopped|Impaired',
]

Result Details

Errors

ConflictException:

The requested operation conflicts with the current state of the specified resource or with another request.

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 Amazon Web Services resources in the IAM user guide.

InternalServerException:

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

TooManyRequestsException:

The request throughput limit was exceeded.

StartTelemetryEvaluation

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

This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

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

Result Syntax

[]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

StopTelemetryEnrichment

$result = $client->stopTelemetryEnrichment([/* ... */]);
$promise = $client->stopTelemetryEnrichmentAsync([/* ... */]);

Disables the resource tags for telemetry feature for your account, stopping the enhancement of telemetry data with additional resource metadata.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Status' => 'Running|Stopped|Impaired',
]

Result Details

Errors

ConflictException:

The requested operation conflicts with the current state of the specified resource or with another request.

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 Amazon Web Services resources in the IAM user guide.

InternalServerException:

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

TooManyRequestsException:

The request throughput limit was exceeded.

StopTelemetryEvaluation

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

This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

StopTelemetryEvaluationForOrganization

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

This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

TagResource

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

Adds or updates tags for a resource. Supports telemetry rule resources and telemetry pipeline resources.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

TestTelemetryPipeline

$result = $client->testTelemetryPipeline([/* ... */]);
$promise = $client->testTelemetryPipelineAsync([/* ... */]);

Tests a pipeline configuration with sample records to validate data processing before deployment. This operation helps ensure your pipeline configuration works as expected.

Parameter Syntax

$result = $client->testTelemetryPipeline([
    'Configuration' => [ // REQUIRED
        'Body' => '<string>', // REQUIRED
    ],
    'Records' => [ // REQUIRED
        [
            'Data' => '<string>',
            'Type' => 'STRING|JSON',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Results' => [
        [
            'Error' => [
                'Message' => '<string>',
            ],
            'Record' => [
                'Data' => '<string>',
                'Type' => 'STRING|JSON',
            ],
        ],
        // ...
    ],
]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

UntagResource

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

Removes tags from a resource. Supports telemetry rule resources and telemetry pipeline resources.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

UpdateCentralizationRuleForOrganization

$result = $client->updateCentralizationRuleForOrganization([/* ... */]);
$promise = $client->updateCentralizationRuleForOrganizationAsync([/* ... */]);

Updates an existing centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

$result = $client->updateCentralizationRuleForOrganization([
    'Rule' => [ // REQUIRED
        'Destination' => [ // REQUIRED
            'Account' => '<string>',
            'DestinationLogsConfiguration' => [
                'BackupConfiguration' => [
                    'KmsKeyArn' => '<string>',
                    'Region' => '<string>', // REQUIRED
                ],
                'LogsEncryptionConfiguration' => [
                    'EncryptionConflictResolutionStrategy' => 'ALLOW|SKIP',
                    'EncryptionStrategy' => 'CUSTOMER_MANAGED|AWS_OWNED', // REQUIRED
                    'KmsKeyArn' => '<string>',
                ],
            ],
            'Region' => '<string>', // REQUIRED
        ],
        'Source' => [ // REQUIRED
            'Regions' => ['<string>', ...], // REQUIRED
            'Scope' => '<string>',
            'SourceLogsConfiguration' => [
                'EncryptedLogGroupStrategy' => 'ALLOW|SKIP', // REQUIRED
                'LogGroupSelectionCriteria' => '<string>', // REQUIRED
            ],
        ],
    ],
    'RuleIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RuleArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

UpdateTelemetryPipeline

$result = $client->updateTelemetryPipeline([/* ... */]);
$promise = $client->updateTelemetryPipelineAsync([/* ... */]);

Updates the configuration of an existing telemetry pipeline.

Source-Specific Update Rules

CloudWatch Logs Sources (Vended and Custom)

Updatable: sts_role_arn

Fixed: data_source_name, data_source_type, sink (must remain @original)

S3 Sources (Crowdstrike, Zscaler, SentinelOne, Custom)

Updatable: All SQS configuration parameters, sts_role_arn, codec settings, compression type, bucket ownership settings, sink log group

Fixed: notification_type, aws.region

GitHub Audit Logs

Updatable: All Amazon Web Services Secrets Manager attributes, scope (can switch between ORGANIZATION/ENTERPRISE), organization or enterprise name, range, authentication credentials (PAT or GitHub App)

Microsoft Sources (Entra ID, Office365, Windows)

Updatable: All Amazon Web Services Secrets Manager attributes, tenant_id, workspace_id (Windows only), OAuth2 credentials (client_id, client_secret)

Okta Sources (SSO, Auth0)

Updatable: All Amazon Web Services Secrets Manager attributes, domain, range (SSO only), OAuth2 credentials (client_id, client_secret)

Palo Alto Networks

Updatable: All Amazon Web Services Secrets Manager attributes, hostname, basic authentication credentials (username, password)

ServiceNow CMDB

Updatable: All Amazon Web Services Secrets Manager attributes, instance_url, range, OAuth2 credentials (client_id, client_secret)

Wiz CNAPP

Updatable: All Amazon Web Services Secrets Manager attributes, region, range, OAuth2 credentials (client_id, client_secret)

Parameter Syntax

$result = $client->updateTelemetryPipeline([
    'Configuration' => [ // REQUIRED
        'Body' => '<string>', // REQUIRED
    ],
    'PipelineIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

UpdateTelemetryRule

$result = $client->updateTelemetryRule([/* ... */]);
$promise = $client->updateTelemetryRuleAsync([/* ... */]);

Updates an existing telemetry rule in your account. If multiple users attempt to modify the same telemetry rule simultaneously, a ConflictException is returned to provide specific error information for concurrent modification scenarios.

Parameter Syntax

$result = $client->updateTelemetryRule([
    'Rule' => [ // REQUIRED
        'DestinationConfiguration' => [
            'CloudtrailParameters' => [
                'AdvancedEventSelectors' => [ // REQUIRED
                    [
                        'FieldSelectors' => [ // REQUIRED
                            [
                                'EndsWith' => ['<string>', ...],
                                'Equals' => ['<string>', ...],
                                'Field' => '<string>', // REQUIRED
                                'NotEndsWith' => ['<string>', ...],
                                'NotEquals' => ['<string>', ...],
                                'NotStartsWith' => ['<string>', ...],
                                'StartsWith' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DestinationPattern' => '<string>',
            'DestinationType' => 'cloud-watch-logs',
            'ELBLoadBalancerLoggingParameters' => [
                'FieldDelimiter' => '<string>',
                'OutputFormat' => 'plain|json',
            ],
            'LogDeliveryParameters' => [
                'LogTypes' => ['<string>', ...],
            ],
            'RetentionInDays' => <integer>,
            'VPCFlowLogParameters' => [
                'LogFormat' => '<string>',
                'MaxAggregationInterval' => <integer>,
                'TrafficType' => '<string>',
            ],
            'WAFLoggingParameters' => [
                'LogType' => 'WAF_LOGS',
                'LoggingFilter' => [
                    'DefaultBehavior' => 'KEEP|DROP',
                    'Filters' => [
                        [
                            'Behavior' => 'KEEP|DROP',
                            'Conditions' => [
                                [
                                    'ActionCondition' => [
                                        'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT',
                                    ],
                                    'LabelNameCondition' => [
                                        'LabelName' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'Requirement' => 'MEETS_ALL|MEETS_ANY',
                        ],
                        // ...
                    ],
                ],
                'RedactedFields' => [
                    [
                        'Method' => '<string>',
                        'QueryString' => '<string>',
                        'SingleHeader' => [
                            'Name' => '<string>',
                        ],
                        'UriPath' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
        'Scope' => '<string>',
        'SelectionCriteria' => '<string>',
        'TelemetrySourceTypes' => ['<string>', ...],
        'TelemetryType' => 'Logs|Metrics|Traces', // REQUIRED
    ],
    'RuleIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RuleArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

ConflictException:

The requested operation conflicts with the current state of the specified resource or with another request.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

UpdateTelemetryRuleForOrganization

$result = $client->updateTelemetryRuleForOrganization([/* ... */]);
$promise = $client->updateTelemetryRuleForOrganizationAsync([/* ... */]);

Updates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameter Syntax

$result = $client->updateTelemetryRuleForOrganization([
    'Rule' => [ // REQUIRED
        'DestinationConfiguration' => [
            'CloudtrailParameters' => [
                'AdvancedEventSelectors' => [ // REQUIRED
                    [
                        'FieldSelectors' => [ // REQUIRED
                            [
                                'EndsWith' => ['<string>', ...],
                                'Equals' => ['<string>', ...],
                                'Field' => '<string>', // REQUIRED
                                'NotEndsWith' => ['<string>', ...],
                                'NotEquals' => ['<string>', ...],
                                'NotStartsWith' => ['<string>', ...],
                                'StartsWith' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DestinationPattern' => '<string>',
            'DestinationType' => 'cloud-watch-logs',
            'ELBLoadBalancerLoggingParameters' => [
                'FieldDelimiter' => '<string>',
                'OutputFormat' => 'plain|json',
            ],
            'LogDeliveryParameters' => [
                'LogTypes' => ['<string>', ...],
            ],
            'RetentionInDays' => <integer>,
            'VPCFlowLogParameters' => [
                'LogFormat' => '<string>',
                'MaxAggregationInterval' => <integer>,
                'TrafficType' => '<string>',
            ],
            'WAFLoggingParameters' => [
                'LogType' => 'WAF_LOGS',
                'LoggingFilter' => [
                    'DefaultBehavior' => 'KEEP|DROP',
                    'Filters' => [
                        [
                            'Behavior' => 'KEEP|DROP',
                            'Conditions' => [
                                [
                                    'ActionCondition' => [
                                        'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT',
                                    ],
                                    'LabelNameCondition' => [
                                        'LabelName' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'Requirement' => 'MEETS_ALL|MEETS_ANY',
                        ],
                        // ...
                    ],
                ],
                'RedactedFields' => [
                    [
                        'Method' => '<string>',
                        'QueryString' => '<string>',
                        'SingleHeader' => [
                            'Name' => '<string>',
                        ],
                        'UriPath' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        'ResourceType' => 'AWS::EC2::Instance|AWS::EC2::VPC|AWS::Lambda::Function|AWS::CloudTrail|AWS::EKS::Cluster|AWS::WAFv2::WebACL|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::Route53Resolver::ResolverEndpoint|AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Browser|AWS::BedrockAgentCore::CodeInterpreter',
        'Scope' => '<string>',
        'SelectionCriteria' => '<string>',
        'TelemetrySourceTypes' => ['<string>', ...],
        'TelemetryType' => 'Logs|Metrics|Traces', // REQUIRED
    ],
    'RuleIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RuleArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The requested operation would exceed the allowed quota for the specified resource type.

ResourceNotFoundException:

The specified resource (such as a telemetry rule) could not be found.

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.

ValidateTelemetryPipelineConfiguration

$result = $client->validateTelemetryPipelineConfiguration([/* ... */]);
$promise = $client->validateTelemetryPipelineConfigurationAsync([/* ... */]);

Validates a pipeline configuration without creating the pipeline. This operation checks the configuration for syntax errors and compatibility issues.

Parameter Syntax

$result = $client->validateTelemetryPipelineConfiguration([
    'Configuration' => [ // REQUIRED
        'Body' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'FieldMap' => ['<string>', ...],
            'Message' => '<string>',
            'Reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

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 Amazon Web Services 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.

TooManyRequestsException:

The request throughput limit was exceeded.