AWS Resilience Hub

Initiates the export task of metrics.

See also: AWS API Documentation

Request Syntax

client.start_metrics_export(
    bucketName='string',
    clientToken='string'
)

type bucketName:

string

param bucketName:

(Optional) Specifies the name of the Amazon Simple Storage Service bucket where the exported metrics will be stored.

type clientToken:

string

param clientToken:

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'metricsExportId': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success'
}

Response Structure

• (dict) --

  • metricsExportId (string) --

    Identifier of the metrics export task.

  • status (string) --

    Indicates the status of the metrics export task.

Describes the metrics of the application configuration being exported.

See also: AWS API Documentation

Request Syntax

client.describe_metrics_export(
    metricsExportId='string'
)

type metricsExportId:

string

param metricsExportId:

[REQUIRED]

Identifier of the metrics export task.

rtype:

dict

returns:

Response Syntax

{
    'errorMessage': 'string',
    'exportLocation': {
        'bucket': 'string',
        'prefix': 'string'
    },
    'metricsExportId': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success'
}

Response Structure

• (dict) --

  • errorMessage (string) --

    Explains the error that occurred while exporting the metrics.

  • exportLocation (dict) --

    Specifies the name of the Amazon S3 bucket where the exported metrics is stored.

    • bucket (string) --

      The name of the Amazon S3 bucket.

    • prefix (string) --

      The prefix for the Amazon S3 bucket.

  • metricsExportId (string) --

    Identifier for the metrics export task.

  • status (string) --

    Indicates the status of the metrics export task.

Lists the metrics that can be exported.

See also: AWS API Documentation

Request Syntax

client.list_metrics(
    conditions=[
        {
            'field': 'string',
            'operator': 'Equals'|'NotEquals'|'GreaterThen'|'GreaterOrEquals'|'LessThen'|'LessOrEquals',
            'value': 'string'
        },
    ],
    dataSource='string',
    fields=[
        {
            'aggregation': 'Min'|'Max'|'Sum'|'Avg'|'Count',
            'name': 'string'
        },
    ],
    maxResults=123,
    nextToken='string',
    sorts=[
        {
            'ascending': True|False,
            'field': 'string'
        },
    ]
)

type conditions:

list

param conditions:

Indicates the list of all the conditions that were applied on the metrics.

• (dict) --

  Indicates the condition based on which you want to filter the metrics.

  • field (string) -- [REQUIRED]

    Indicates the field in the metric.

  • operator (string) -- [REQUIRED]

    Indicates the type of operator or comparison to be used when evaluating a condition against the specified field.

  • value (string) --

    Indicates the value or data against which a condition is evaluated.

type dataSource:

string

param dataSource:

Indicates the data source of the metrics.

type fields:

list

param fields:

Indicates the list of fields in the data source.

• (dict) --

  Indicates the field or attribute of a resource or data structure on which a condition is being applied or evaluated.

  • aggregation (string) --

    (Optional) Indicates the type of aggregation or summary operation (such as Sum, Average, and so on) to be performed on a particular field or set of data.

  • name (string) -- [REQUIRED]

    Name of the field.

type maxResults:

integer

param maxResults:

Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

type nextToken:

string

param nextToken:

Null, or the token from a previous call to get the next set of results.

type sorts:

list

param sorts:

(Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order.

• (dict) --

  Indicates the sorting order of the fields in the metrics.

  • ascending (boolean) --

    Indicates the name or identifier of the field or attribute that should be used as the basis for sorting the metrics.

  • field (string) -- [REQUIRED]

    Indicates the order in which you want to sort the metrics. By default, the list is sorted in ascending order. To sort the list in descending order, set this field to False.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'rows': [
        [
            'string',
        ],
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    Token for the next set of results, or null if there are no more results.

  • rows (list) --

    Specifies all the list of metric values for each row of metrics.

    • (list) --

      • (string) --