AWS API Changes

2024/11/27 - CloudWatch Observability Admin Service - 8 new api methods

Changes Amazon CloudWatch Observability Admin adds the ability to audit telemetry configuration for AWS resources in customers AWS Accounts and Organizations. The release introduces new APIs to turn on/off the new experience, which supports discovering supported AWS resources and their state of telemetry.

GetTelemetryEvaluationStatus (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.get_telemetry_evaluation_status()

rtype:

dict

returns:

Response Syntax

{
    'Status': 'NOT_STARTED'|'STARTING'|'FAILED_START'|'RUNNING'|'STOPPING'|'FAILED_STOP'|'STOPPED',
    'FailureReason': 'string'
}

Response Structure

(dict) --
- Status (string) --
  
  The onboarding status of the telemetry config feature.
- FailureReason (string) --
  
  Describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.

StopTelemetryEvaluationForOrganization (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.stop_telemetry_evaluation_for_organization()

returns:: None

ListResourceTelemetry (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_resource_telemetry(
    ResourceIdentifierPrefix='string',
    ResourceTypes=[
        'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function',
    ],
    TelemetryConfigurationState={
        'string': 'Enabled'|'Disabled'|'NotApplicable'
    },
    ResourceTags={
        'string': 'string'
    },
    MaxResults=123,
    NextToken='string'
)

type ResourceIdentifierPrefix:

string

param ResourceIdentifierPrefix:

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

type ResourceTypes:

list

param ResourceTypes:

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

(string) --

type TelemetryConfigurationState:

dict

param TelemetryConfigurationState:

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

(string) --
- (string) --

type ResourceTags:

dict

param ResourceTags:

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

(string) --
- (string) --

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'TelemetryConfigurations': [
        {
            'AccountIdentifier': 'string',
            'TelemetryConfigurationState': {
                'string': 'Enabled'|'Disabled'|'NotApplicable'
            },
            'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function',
            'ResourceIdentifier': 'string',
            'ResourceTags': {
                'string': 'string'
            },
            'LastUpdateTimeStamp': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TelemetryConfigurations (list) --
  
  A list of telemetry configurations for AWS resources supported by telemetry config in the caller's account.
  - (dict) --
    
    A model representing the state of a resource within an account according to telemetry config.
    - AccountIdentifier (string) --
      
      The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is 012345678901.
    - TelemetryConfigurationState (dict) --
      
      The configuration state for the resource, for example { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }.
      - (string) --
        
        (string) --
    - ResourceType (string) --
      
      The type of resource, for example AWS::EC2::Instance.
    - ResourceIdentifier (string) --
      
      The identifier of the resource, for example i-0b22a22eec53b9321.
    - ResourceTags (dict) --
      
      Tags associated with the resource, for example { Name: "ExampleInstance", Environment: "Development" }.
      - (string) --
        
        (string) --
    - LastUpdateTimeStamp (integer) --
      
      The timestamp of the last change to the telemetry configuration for the resource. For example, 1728679196318.
- NextToken (string) --
  
  The token for the next set of items to return. A previous call generates this token.

GetTelemetryEvaluationStatusForOrganization (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_telemetry_evaluation_status_for_organization()

rtype:

dict

returns:

Response Syntax

{
    'Status': 'NOT_STARTED'|'STARTING'|'FAILED_START'|'RUNNING'|'STOPPING'|'FAILED_STOP'|'STOPPED',
    'FailureReason': 'string'
}

Response Structure

(dict) --
- Status (string) --
  
  The onboarding status of the telemetry config feature for the organization.
- FailureReason (string) --
  
  This field describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.

ListResourceTelemetryForOrganization (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_resource_telemetry_for_organization(
    AccountIdentifiers=[
        'string',
    ],
    ResourceIdentifierPrefix='string',
    ResourceTypes=[
        'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function',
    ],
    TelemetryConfigurationState={
        'string': 'Enabled'|'Disabled'|'NotApplicable'
    },
    ResourceTags={
        'string': 'string'
    },
    MaxResults=123,
    NextToken='string'
)

type AccountIdentifiers:

list

param AccountIdentifiers:

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

(string) --

type ResourceIdentifierPrefix:

string

param ResourceIdentifierPrefix:

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

type ResourceTypes:

list

param ResourceTypes:

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

(string) --

type TelemetryConfigurationState:

dict

param TelemetryConfigurationState:

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

(string) --
- (string) --

type ResourceTags:

dict

param ResourceTags:

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

(string) --
- (string) --

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'TelemetryConfigurations': [
        {
            'AccountIdentifier': 'string',
            'TelemetryConfigurationState': {
                'string': 'Enabled'|'Disabled'|'NotApplicable'
            },
            'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function',
            'ResourceIdentifier': 'string',
            'ResourceTags': {
                'string': 'string'
            },
            'LastUpdateTimeStamp': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TelemetryConfigurations (list) --
  
  A list of telemetry configurations for AWS resources supported by telemetry config in the organization.
  - (dict) --
    
    A model representing the state of a resource within an account according to telemetry config.
    - AccountIdentifier (string) --
      
      The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is 012345678901.
    - TelemetryConfigurationState (dict) --
      
      The configuration state for the resource, for example { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }.
      - (string) --
        
        (string) --
    - ResourceType (string) --
      
      The type of resource, for example AWS::EC2::Instance.
    - ResourceIdentifier (string) --
      
      The identifier of the resource, for example i-0b22a22eec53b9321.
    - ResourceTags (dict) --
      
      Tags associated with the resource, for example { Name: "ExampleInstance", Environment: "Development" }.
      - (string) --
        
        (string) --
    - LastUpdateTimeStamp (integer) --
      
      The timestamp of the last change to the telemetry configuration for the resource. For example, 1728679196318.
- NextToken (string) --
  
  The token for the next set of items to return. A previous call provides this token.

StartTelemetryEvaluation (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.start_telemetry_evaluation()

returns:: None

StopTelemetryEvaluation (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.stop_telemetry_evaluation()

returns:: None

StartTelemetryEvaluationForOrganization (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.start_telemetry_evaluation_for_organization()

returns:: None