AWS Compute Optimizer

Describes recommendation export jobs created in the last seven days.

Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.

See also: AWS API Documentation

Request Syntax

client.describe_recommendation_export_jobs(
    jobIds=[
        'string',
    ],
    filters=[
        {
            'name': 'ResourceType'|'JobStatus',
            'values': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)

type jobIds:

list

param jobIds:

The identification numbers of the export jobs to return.

An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.

All export jobs created in the last seven days are returned if this parameter is omitted.

• (string) --

type filters:

list

param filters:

An array of objects that describe a filter to return a more specific list of export jobs.

• (dict) --

  Describes a filter that returns a more specific list of recommendation export jobs.

  This filter is used with the DescribeRecommendationExportJobs action.

  • name (string) --

    The name of the filter.

    Specify ResourceType to return export jobs of a specific resource type (e.g., Ec2Instance).

    Specify JobStatus to return export jobs with a specific status (e.g, Complete).

  • values (list) --

    The value of the filter.

    If you specify the name parameter as ResourceType, the valid values are Ec2Instance or AutoScalingGroup.

    If you specify the name parameter as JobStatus, the valid values are Queued, InProgress, Complete, or Failed.

    • (string) --

type nextToken:

string

param nextToken:

The token to advance to the next page of export jobs.

type maxResults:

integer

param maxResults:

The maximum number of export jobs to return with a single request.

To retrieve the remaining results, make another request with the returned NextToken value.

rtype:

dict

returns:

Response Syntax

{
    'recommendationExportJobs': [
        {
            'jobId': 'string',
            'destination': {
                's3': {
                    'bucket': 'string',
                    'key': 'string',
                    'metadataKey': 'string'
                }
            },
            'resourceType': 'Ec2Instance'|'AutoScalingGroup',
            'status': 'Queued'|'InProgress'|'Complete'|'Failed',
            'creationTimestamp': datetime(2015, 1, 1),
            'lastUpdatedTimestamp': datetime(2015, 1, 1),
            'failureReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • recommendationExportJobs (list) --

    An array of objects that describe recommendation export jobs.

    • (dict) --

      Describes a recommendation export job.

      Use the DescribeRecommendationExportJobs action to view your recommendation export jobs.

      Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations.

      • jobId (string) --

        The identification number of the export job.

      • destination (dict) --

        An object that describes the destination of the export file.

        • s3 (dict) --

          An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.

          • bucket (string) --

            The name of the Amazon S3 bucket used as the destination of an export file.

          • key (string) --

            The Amazon S3 bucket key of an export file.

            The key uniquely identifies the object, or export file, in the S3 bucket.

          • metadataKey (string) --

            The Amazon S3 bucket key of a metadata file.

            The key uniquely identifies the object, or metadata file, in the S3 bucket.

      • resourceType (string) --

        The resource type of the exported recommendations.

      • status (string) --

        The status of the export job.

      • creationTimestamp (datetime) --

        The timestamp of when the export job was created.

      • lastUpdatedTimestamp (datetime) --

        The timestamp of when the export job was last updated.

      • failureReason (string) --

        The reason for an export job failure.

  • nextToken (string) --

    The token to use to advance to the next page of export jobs.

    This value is null when there are no more pages of export jobs to return.

Exports optimization recommendations for Auto Scaling groups.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Auto Scaling group export job in progress per AWS Region.

See also: AWS API Documentation

Request Syntax

client.export_auto_scaling_group_recommendations(
    accountIds=[
        'string',
    ],
    filters=[
        {
            'name': 'Finding'|'RecommendationSourceType',
            'values': [
                'string',
            ]
        },
    ],
    fieldsToExport=[
        'AccountId'|'AutoScalingGroupArn'|'AutoScalingGroupName'|'Finding'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'LookbackPeriodInDays'|'CurrentConfigurationInstanceType'|'CurrentConfigurationDesiredCapacity'|'CurrentConfigurationMinSize'|'CurrentConfigurationMaxSize'|'CurrentOnDemandPrice'|'CurrentStandardOneYearNoUpfrontReservedPrice'|'CurrentStandardThreeYearNoUpfrontReservedPrice'|'CurrentVCpus'|'CurrentMemory'|'CurrentStorage'|'CurrentNetwork'|'RecommendationOptionsConfigurationInstanceType'|'RecommendationOptionsConfigurationDesiredCapacity'|'RecommendationOptionsConfigurationMinSize'|'RecommendationOptionsConfigurationMaxSize'|'RecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum'|'RecommendationOptionsPerformanceRisk'|'RecommendationOptionsOnDemandPrice'|'RecommendationOptionsStandardOneYearNoUpfrontReservedPrice'|'RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice'|'RecommendationOptionsVcpus'|'RecommendationOptionsMemory'|'RecommendationOptionsStorage'|'RecommendationOptionsNetwork'|'LastRefreshTimestamp',
    ],
    s3DestinationConfig={
        'bucket': 'string',
        'keyPrefix': 'string'
    },
    fileFormat='Csv',
    includeMemberAccounts=True|False
)

type accountIds:

list

param accountIds:

The IDs of the AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

• (string) --

type filters:

list

param filters:

An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.

• (dict) --

  Describes a filter that returns a more specific list of recommendations.

  • name (string) --

    The name of the filter.

    Specify Finding to return recommendations with a specific findings classification (e.g., Overprovisioned).

    Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup).

  • values (list) --

    The value of the filter.

    If you specify the name parameter as Finding, and you request recommendations for an instance, then the valid values are Underprovisioned, Overprovisioned, NotOptimized, or Optimized.

    If you specify the name parameter as Finding, and you request recommendations for an Auto Scaling group, then the valid values are Optimized, or NotOptimized.

    If you specify the name parameter as RecommendationSourceType, then the valid values are Ec2Instance, or AutoScalingGroup.

    • (string) --

type fieldsToExport:

list

param fieldsToExport:

The recommendations data to include in the export file.

• (string) --

type s3DestinationConfig:

dict

param s3DestinationConfig:

[REQUIRED]

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.

• bucket (string) --

  The name of the Amazon S3 bucket to use as the destination for an export job.

• keyPrefix (string) --

  The Amazon S3 bucket prefix for an export job.

type fileFormat:

string

param fileFormat:

The format of the export file.

The only export file format currently supported is Csv.

type includeMemberAccounts:

boolean

param includeMemberAccounts:

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

rtype:

dict

returns:

Response Syntax

{
    'jobId': 'string',
    's3Destination': {
        'bucket': 'string',
        'key': 'string',
        'metadataKey': 'string'
    }
}

Response Structure

• (dict) --

  • jobId (string) --

    The identification number of the export job.

    Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

  • s3Destination (dict) --

    An object that describes the destination Amazon S3 bucket of a recommendations export file.

    • bucket (string) --

      The name of the Amazon S3 bucket used as the destination of an export file.

    • key (string) --

      The Amazon S3 bucket key of an export file.

      The key uniquely identifies the object, or export file, in the S3 bucket.

    • metadataKey (string) --

      The Amazon S3 bucket key of a metadata file.

      The key uniquely identifies the object, or metadata file, in the S3 bucket.

Exports optimization recommendations for Amazon EC2 instances.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Amazon EC2 instance export job in progress per AWS Region.

See also: AWS API Documentation

Request Syntax

client.export_ec2_instance_recommendations(
    accountIds=[
        'string',
    ],
    filters=[
        {
            'name': 'Finding'|'RecommendationSourceType',
            'values': [
                'string',
            ]
        },
    ],
    fieldsToExport=[
        'AccountId'|'InstanceArn'|'InstanceName'|'Finding'|'LookbackPeriodInDays'|'CurrentInstanceType'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'CurrentOnDemandPrice'|'CurrentStandardOneYearNoUpfrontReservedPrice'|'CurrentStandardThreeYearNoUpfrontReservedPrice'|'CurrentVCpus'|'CurrentMemory'|'CurrentStorage'|'CurrentNetwork'|'RecommendationOptionsInstanceType'|'RecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum'|'RecommendationOptionsPerformanceRisk'|'RecommendationOptionsVcpus'|'RecommendationOptionsMemory'|'RecommendationOptionsStorage'|'RecommendationOptionsNetwork'|'RecommendationOptionsOnDemandPrice'|'RecommendationOptionsStandardOneYearNoUpfrontReservedPrice'|'RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice'|'RecommendationsSourcesRecommendationSourceArn'|'RecommendationsSourcesRecommendationSourceType'|'LastRefreshTimestamp',
    ],
    s3DestinationConfig={
        'bucket': 'string',
        'keyPrefix': 'string'
    },
    fileFormat='Csv',
    includeMemberAccounts=True|False
)

type accountIds:

list

param accountIds:

The IDs of the AWS accounts for which to export instance recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

• (string) --

type filters:

list

param filters:

An array of objects that describe a filter to export a more specific set of instance recommendations.

• (dict) --

  Describes a filter that returns a more specific list of recommendations.

  • name (string) --

    The name of the filter.

    Specify Finding to return recommendations with a specific findings classification (e.g., Overprovisioned).

    Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup).

  • values (list) --

    The value of the filter.

    If you specify the name parameter as Finding, and you request recommendations for an instance, then the valid values are Underprovisioned, Overprovisioned, NotOptimized, or Optimized.

    If you specify the name parameter as Finding, and you request recommendations for an Auto Scaling group, then the valid values are Optimized, or NotOptimized.

    If you specify the name parameter as RecommendationSourceType, then the valid values are Ec2Instance, or AutoScalingGroup.

    • (string) --

type fieldsToExport:

list

param fieldsToExport:

The recommendations data to include in the export file.

• (string) --

type s3DestinationConfig:

dict

param s3DestinationConfig:

[REQUIRED]

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.

• bucket (string) --

  The name of the Amazon S3 bucket to use as the destination for an export job.

• keyPrefix (string) --

  The Amazon S3 bucket prefix for an export job.

type fileFormat:

string

param fileFormat:

The format of the export file.

The only export file format currently supported is Csv.

type includeMemberAccounts:

boolean

param includeMemberAccounts:

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

rtype:

dict

returns:

Response Syntax

{
    'jobId': 'string',
    's3Destination': {
        'bucket': 'string',
        'key': 'string',
        'metadataKey': 'string'
    }
}

Response Structure

• (dict) --

  • jobId (string) --

    The identification number of the export job.

    Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

  • s3Destination (dict) --

    An object that describes the destination Amazon S3 bucket of a recommendations export file.

    • bucket (string) --

      The name of the Amazon S3 bucket used as the destination of an export file.

    • key (string) --

      The Amazon S3 bucket key of an export file.

      The key uniquely identifies the object, or export file, in the S3 bucket.

    • metadataKey (string) --

      The Amazon S3 bucket key of a metadata file.

      The key uniquely identifies the object, or metadata file, in the S3 bucket.