CloudWatchObservabilityAdminService / Client / get_connector_telemetry_setup

get_connector_telemetry_setup

CloudWatchObservabilityAdminService.Client.get_connector_telemetry_setup(**kwargs)

Generates the artifacts that you use to create the infrastructure in your cloud provider that delivers the telemetry declared in the connector’s telemetry manifest. This operation doesn’t change any resources in your cloud provider or in Amazon Web Services.

See also: AWS API Documentation

Request Syntax

response = client.get_connector_telemetry_setup(
    ConnectorIdentifier='string',
    Format='BICEP'
)
Parameters:
  • ConnectorIdentifier (string) –

    [REQUIRED]

    The connector whose telemetry manifest you want to generate the setup from. Specify one of the following:

    • The Amazon Resource Name (ARN) of the connector

    • The ID of the connector

  • Format (string) – The format of the setup artifacts. If you omit this value, the service uses the default format for the connector’s provider ( BICEP for an Azure connector). If the provider doesn’t support the format, the service returns a ValidationException.

Return type:

dict

Returns:

Response Syntax

{
    'Artifacts': [
        {
            'FileName': 'string',
            'Content': 'string',
            'Format': 'BICEP',
            'ContentType': 'string'
        },
    ],
    'RequiredPermissionsToApply': [
        'string',
    ],
    'Format': 'BICEP',
    'Provider': 'AZURE',
    'ManifestVersion': 123
}

Response Structure

  • (dict) –

    • Artifacts (list) –

      The setup artifacts to apply in your cloud provider.

      • (dict) –

        A setup artifact, which is one file in the requested format.

        • FileName (string) –

          The suggested file name, for example main.bicep.

        • Content (string) –

          The content of the artifact.

        • Format (string) –

          The format of the artifact.

        • ContentType (string) –

          The content type of the artifact, for example text/plain.

    • RequiredPermissionsToApply (list) –

      The permissions or roles in your cloud provider that you need to apply the artifacts, for example Azure Contributor and User Access Administrator.

      • (string) –

    • Format (string) –

      The format of the setup artifacts.

    • Provider (string) –

      The cloud provider that the setup artifacts are for.

    • ManifestVersion (integer) –

      The version of the telemetry manifest that the service generated the setup artifacts from.

Exceptions