[ aws . observabilityadmin ]
Starts a third-party telemetry enrichment. An enrichment adds resource metadata, such as tags, from a third-party telemetry source to the telemetry that CloudWatch receives from the resources of that source.
You specify an Amazon Web Services Config connector for your third-party environment, such as a Microsoft Azure tenant. You can use each connector for only one enrichment.
To use this operation, you must have the config:PutThirdPartyServiceLinkedConfigurationRecorder permission. If the Amazon Web Services Config service-linked role does not exist in your account, you must also have the iam:CreateServiceLinkedRole permission.
See also: AWS API Documentation
start-third-party-telemetry-enrichment
--name <value>
--telemetry-source-configuration <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
--name (string) [required]
A name for the enrichment. The name must be unique in your account and Region. You can use the name instead of the ARN to identify the enrichment in other operations.
Constraints:
- min:
1- max:
64- pattern:
[a-zA-Z][a-zA-Z0-9\-]*
--telemetry-source-configuration (tagged union structure) [required]
The third-party telemetry source to collect resource metadata from. Specify exactly one telemetry source.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Azure.Azure -> (structure)
The configuration for a Microsoft Azure source.
AwsConfigConnectorArn -> (string) [required]
The Amazon Resource Name (ARN) of the Amazon Web Services Config connector for the Microsoft Azure tenant to collect resource metadata from.
Constraints:
- min:
20- max:
2048- pattern:
arn:aws(-[a-z]+)*:config:[a-z0-9\-]+:[0-9]{12}:connector/[^\r\n]+
Shorthand Syntax:
Azure={AwsConfigConnectorArn=string}
JSON Syntax:
{
"Azure": {
"AwsConfigConnectorArn": "string"
}
}
--tags (map)
The tags to associate with the enrichment resource.
Constraints:
- min:
1- max:
50key -> (string)
Constraints:
- min:
1- max:
128- pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)value -> (string)
Constraints:
- min:
0- max:
256- pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
--help (boolean)
Display help for the command/subcommand.
Arn -> (string)
The Amazon Resource Name (ARN) of the enrichment.
Constraints:
- min:
20- max:
2048- pattern:
arn:aws(-[a-z]+)*:observabilityadmin:[a-z0-9\-]+:[0-9]{12}:telemetry-enrichments/[a-z][a-z0-9]{9,63}
Name -> (string)
The name of the enrichment.
Constraints:
- min:
1- max:
64- pattern:
[a-zA-Z][a-zA-Z0-9\-]*
Status -> (string)
The status of the enrichment after the start operation. Valid values:
Initializing- CloudWatch is setting up the enrichment. Some telemetry can be enriched before setup completes.Running- The enrichment is active.Stopped- The enrichment is stopped.Impaired- The enrichment has a problem.StatusReasondescribes the problem.Possible values:
InitializingRunningStoppedImpaired
StatusReason -> (string)
The reason for the current status. This field is present when the status isImpaired.
TelemetrySourceConfiguration -> (tagged union structure)
The source configuration of the enrichment.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Azure.Azure -> (structure)
The configuration of the Microsoft Azure source.
AwsConfigConnectorArn -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services Config connector that the enrichment uses.
Constraints:
- min:
20- max:
2048- pattern:
arn:aws(-[a-z]+)*:config:[a-z0-9\-]+:[0-9]{12}:connector/[^\r\n]+ServiceLinkedRecorderArn -> (string)
The Amazon Resource Name (ARN) of the service-linked configuration recorder that CloudWatch created in your account for the enrichment.
Constraints:
- min:
20- max:
2048- pattern:
arn:aws(-[a-z]+)*:config:[a-z0-9\-]+:[0-9]{12}:configuration-recorder/[^\r\n]+
Tags -> (map)
The tags associated with the enrichment.
key -> (string)
value -> (string)