ComputeOptimizer

Client

class ComputeOptimizer.Client

A low-level client representing AWS Compute Optimizer:

client = session.create_client('compute-optimizer')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
describe_recommendation_export_jobs(**kwargs)

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

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

    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) --
  • filters (list) --

    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) --
  • nextToken (string) -- The token to advance to the next page of export jobs.
  • maxResults (integer) --

    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.

Return type

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.

Exceptions

export_auto_scaling_group_recommendations(**kwargs)

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

response = 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
)
Parameters
  • accountIds (list) --

    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) --
  • filters (list) --

    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) --
  • fieldsToExport (list) --

    The recommendations data to include in the export file.

    • (string) --
  • s3DestinationConfig (dict) --

    [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.

  • fileFormat (string) --

    The format of the export file.

    The only export file format currently supported is Csv .

  • includeMemberAccounts (boolean) --

    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.

Return type

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.

Exceptions

export_ec2_instance_recommendations(**kwargs)

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

response = 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
)
Parameters
  • accountIds (list) --

    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) --
  • filters (list) --

    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) --
  • fieldsToExport (list) --

    The recommendations data to include in the export file.

    • (string) --
  • s3DestinationConfig (dict) --

    [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.

  • fileFormat (string) --

    The format of the export file.

    The only export file format currently supported is Csv .

  • includeMemberAccounts (boolean) --

    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.

Return type

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.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_auto_scaling_group_recommendations(**kwargs)

Returns Auto Scaling group recommendations.

AWS Compute Optimizer currently generates recommendations for Auto Scaling groups that are configured to run instances of the M, C, R, T, and X instance families. The service does not generate recommendations for Auto Scaling groups that have a scaling policy attached to them, or that do not have the same values for desired, minimum, and maximum capacity. In order for Compute Optimizer to analyze your Auto Scaling groups, they must be of a fixed size. For more information, see the AWS Compute Optimizer User Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_auto_scaling_group_recommendations(
    accountIds=[
        'string',
    ],
    autoScalingGroupArns=[
        'string',
    ],
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'Finding'|'RecommendationSourceType',
            'values': [
                'string',
            ]
        },
    ]
)
Parameters
  • accountIds (list) --

    The IDs of the AWS accounts for which to return 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 return Auto Scaling group recommendations.

    Only one account ID can be specified per request.

    • (string) --
  • autoScalingGroupArns (list) --

    The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.

    • (string) --
  • nextToken (string) -- The token to advance to the next page of Auto Scaling group recommendations.
  • maxResults (integer) --

    The maximum number of Auto Scaling group recommendations to return with a single request.

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

  • filters (list) --

    An array of objects that describe a filter that returns a more specific list 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) --
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'autoScalingGroupRecommendations': [
        {
            'accountId': 'string',
            'autoScalingGroupArn': 'string',
            'autoScalingGroupName': 'string',
            'finding': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
            'utilizationMetrics': [
                {
                    'name': 'Cpu'|'Memory',
                    'statistic': 'Maximum'|'Average',
                    'value': 123.0
                },
            ],
            'lookBackPeriodInDays': 123.0,
            'currentConfiguration': {
                'desiredCapacity': 123,
                'minSize': 123,
                'maxSize': 123,
                'instanceType': 'string'
            },
            'recommendationOptions': [
                {
                    'configuration': {
                        'desiredCapacity': 123,
                        'minSize': 123,
                        'maxSize': 123,
                        'instanceType': 'string'
                    },
                    'projectedUtilizationMetrics': [
                        {
                            'name': 'Cpu'|'Memory',
                            'statistic': 'Maximum'|'Average',
                            'value': 123.0
                        },
                    ],
                    'performanceRisk': 123.0,
                    'rank': 123
                },
            ],
            'lastRefreshTimestamp': datetime(2015, 1, 1)
        },
    ],
    'errors': [
        {
            'identifier': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token to use to advance to the next page of Auto Scaling group recommendations.

      This value is null when there are no more pages of Auto Scaling group recommendations to return.

    • autoScalingGroupRecommendations (list) --

      An array of objects that describe Auto Scaling group recommendations.

      • (dict) --

        Describes an Auto Scaling group recommendation.

        • accountId (string) --

          The AWS account ID of the Auto Scaling group.

        • autoScalingGroupArn (string) --

          The Amazon Resource Name (ARN) of the Auto Scaling group.

        • autoScalingGroupName (string) --

          The name of the Auto Scaling group.

        • finding (string) --

          The finding classification for the Auto Scaling group.

          Findings for Auto Scaling groups include:

          • **NotOptimized ** —An Auto Scaling group is considered not optimized when AWS Compute Optimizer identifies a recommendation that can provide better performance for your workload.
          • **Optimized ** —An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.

          Note

          The values that are returned might be NOT_OPTIMIZED or OPTIMIZED .

        • utilizationMetrics (list) --

          An array of objects that describe the utilization metrics of the Auto Scaling group.

          • (dict) --

            Describes a utilization metric of a resource, such as an Amazon EC2 instance.

            • name (string) --

              The name of the utilization metric.

              Note

              Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .

            • statistic (string) --

              The statistic of the utilization metric.

            • value (float) --

              The value of the utilization metric.

        • lookBackPeriodInDays (float) --

          The number of days for which utilization metrics were analyzed for the Auto Scaling group.

        • currentConfiguration (dict) --

          An array of objects that describe the current configuration of the Auto Scaling group.

          • desiredCapacity (integer) --

            The desired capacity, or number of instances, for the Auto Scaling group.

          • minSize (integer) --

            The minimum size, or minimum number of instances, for the Auto Scaling group.

          • maxSize (integer) --

            The maximum size, or maximum number of instances, for the Auto Scaling group.

          • instanceType (string) --

            The instance type for the Auto Scaling group.

        • recommendationOptions (list) --

          An array of objects that describe the recommendation options for the Auto Scaling group.

          • (dict) --

            Describes a recommendation option for an Auto Scaling group.

            • configuration (dict) --

              An array of objects that describe an Auto Scaling group configuration.

              • desiredCapacity (integer) --

                The desired capacity, or number of instances, for the Auto Scaling group.

              • minSize (integer) --

                The minimum size, or minimum number of instances, for the Auto Scaling group.

              • maxSize (integer) --

                The maximum size, or maximum number of instances, for the Auto Scaling group.

              • instanceType (string) --

                The instance type for the Auto Scaling group.

            • projectedUtilizationMetrics (list) --

              An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.

              • (dict) --

                Describes a utilization metric of a resource, such as an Amazon EC2 instance.

                • name (string) --

                  The name of the utilization metric.

                  Note

                  Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .

                • statistic (string) --

                  The statistic of the utilization metric.

                • value (float) --

                  The value of the utilization metric.

            • performanceRisk (float) --

              The performance risk of the Auto Scaling group configuration recommendation.

              Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload.

              The lowest performance risk is categorized as 0 , and the highest as 5 .

            • rank (integer) --

              The rank of the Auto Scaling group recommendation option.

              The top recommendation option is ranked as 1 .

        • lastRefreshTimestamp (datetime) --

          The time stamp of when the Auto Scaling group recommendation was last refreshed.

    • errors (list) --

      An array of objects that describe errors of the request.

      For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.

      • (dict) --

        Describes an error experienced when getting recommendations.

        For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.

        • identifier (string) --

          The ID of the error.

        • code (string) --

          The error code.

        • message (string) --

          The message, or reason, for the error.

Exceptions

get_ec2_instance_recommendations(**kwargs)

Returns Amazon EC2 instance recommendations.

AWS Compute Optimizer currently generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) and Amazon EC2 Auto Scaling. It generates recommendations for M, C, R, T, and X instance families. For more information, see the AWS Compute Optimizer User Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_ec2_instance_recommendations(
    instanceArns=[
        'string',
    ],
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'Finding'|'RecommendationSourceType',
            'values': [
                'string',
            ]
        },
    ],
    accountIds=[
        'string',
    ]
)
Parameters
  • instanceArns (list) --

    The Amazon Resource Name (ARN) of the instances for which to return recommendations.

    • (string) --
  • nextToken (string) -- The token to advance to the next page of instance recommendations.
  • maxResults (integer) --

    The maximum number of instance recommendations to return with a single request.

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

  • filters (list) --

    An array of objects that describe a filter that returns a more specific list 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) --
  • accountIds (list) --

    The IDs of the AWS accounts for which to return 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 return instance recommendations.

    Only one account ID can be specified per request.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'instanceRecommendations': [
        {
            'instanceArn': 'string',
            'accountId': 'string',
            'instanceName': 'string',
            'currentInstanceType': 'string',
            'finding': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
            'utilizationMetrics': [
                {
                    'name': 'Cpu'|'Memory',
                    'statistic': 'Maximum'|'Average',
                    'value': 123.0
                },
            ],
            'lookBackPeriodInDays': 123.0,
            'recommendationOptions': [
                {
                    'instanceType': 'string',
                    'projectedUtilizationMetrics': [
                        {
                            'name': 'Cpu'|'Memory',
                            'statistic': 'Maximum'|'Average',
                            'value': 123.0
                        },
                    ],
                    'performanceRisk': 123.0,
                    'rank': 123
                },
            ],
            'recommendationSources': [
                {
                    'recommendationSourceArn': 'string',
                    'recommendationSourceType': 'Ec2Instance'|'AutoScalingGroup'
                },
            ],
            'lastRefreshTimestamp': datetime(2015, 1, 1)
        },
    ],
    'errors': [
        {
            'identifier': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token to use to advance to the next page of instance recommendations.

      This value is null when there are no more pages of instance recommendations to return.

    • instanceRecommendations (list) --

      An array of objects that describe instance recommendations.

      • (dict) --

        Describes an Amazon EC2 instance recommendation.

        • instanceArn (string) --

          The Amazon Resource Name (ARN) of the current instance.

        • accountId (string) --

          The AWS account ID of the instance.

        • instanceName (string) --

          The name of the current instance.

        • currentInstanceType (string) --

          The instance type of the current instance.

        • finding (string) --

          The finding classification for the instance.

          Findings for instances include:

          • **Underprovisioned ** —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
          • **Overprovisioned ** —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
          • **Optimized ** —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.

          Note

          The values that are returned might be UNDER_PROVISIONED , OVER_PROVISIONED , or OPTIMIZED .

        • utilizationMetrics (list) --

          An array of objects that describe the utilization metrics of the instance.

          • (dict) --

            Describes a utilization metric of a resource, such as an Amazon EC2 instance.

            • name (string) --

              The name of the utilization metric.

              Note

              Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .

            • statistic (string) --

              The statistic of the utilization metric.

            • value (float) --

              The value of the utilization metric.

        • lookBackPeriodInDays (float) --

          The number of days for which utilization metrics were analyzed for the instance.

        • recommendationOptions (list) --

          An array of objects that describe the recommendation options for the instance.

          • (dict) --

            Describes a recommendation option for an Amazon EC2 instance.

            • instanceType (string) --

              The instance type of the instance recommendation.

            • projectedUtilizationMetrics (list) --

              An array of objects that describe the projected utilization metrics of the instance recommendation option.

              • (dict) --

                Describes a utilization metric of a resource, such as an Amazon EC2 instance.

                • name (string) --

                  The name of the utilization metric.

                  Note

                  Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .

                • statistic (string) --

                  The statistic of the utilization metric.

                • value (float) --

                  The value of the utilization metric.

            • performanceRisk (float) --

              The performance risk of the instance recommendation option.

              Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload.

              The lowest performance risk is categorized as 0 , and the highest as 5 .

            • rank (integer) --

              The rank of the instance recommendation option.

              The top recommendation option is ranked as 1 .

        • recommendationSources (list) --

          An array of objects that describe the source resource of the recommendation.

          • (dict) --

            Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.

            • recommendationSourceArn (string) --

              The Amazon Resource Name (ARN) of the recommendation source.

            • recommendationSourceType (string) --

              The resource type of the recommendation source.

        • lastRefreshTimestamp (datetime) --

          The time stamp of when the instance recommendation was last refreshed.

    • errors (list) --

      An array of objects that describe errors of the request.

      For example, an error is returned if you request recommendations for an instance of an unsupported instance family.

      • (dict) --

        Describes an error experienced when getting recommendations.

        For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.

        • identifier (string) --

          The ID of the error.

        • code (string) --

          The error code.

        • message (string) --

          The message, or reason, for the error.

Exceptions

get_ec2_recommendation_projected_metrics(**kwargs)

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

See also: AWS API Documentation

Request Syntax

response = client.get_ec2_recommendation_projected_metrics(
    instanceArn='string',
    stat='Maximum'|'Average',
    period=123,
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1)
)
Parameters
  • instanceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.

  • stat (string) --

    [REQUIRED]

    The statistic of the projected metrics.

  • period (integer) --

    [REQUIRED]

    The granularity, in seconds, of the projected metrics data points.

  • startTime (datetime) --

    [REQUIRED]

    The time stamp of the first projected metrics data point to return.

  • endTime (datetime) --

    [REQUIRED]

    The time stamp of the last projected metrics data point to return.

Return type

dict

Returns

Response Syntax

{
    'recommendedOptionProjectedMetrics': [
        {
            'recommendedInstanceType': 'string',
            'rank': 123,
            'projectedMetrics': [
                {
                    'name': 'Cpu'|'Memory',
                    'timestamps': [
                        datetime(2015, 1, 1),
                    ],
                    'values': [
                        123.0,
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • recommendedOptionProjectedMetrics (list) --

      An array of objects that describe a projected metrics.

      • (dict) --

        Describes a projected utilization metric of a recommendation option.

        • recommendedInstanceType (string) --

          The recommended instance type.

        • rank (integer) --

          The rank of the recommendation option projected metric.

          The top recommendation option is ranked as 1 .

          The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1 is related to the recommendation option that is also ranked as 1 in the same response.

        • projectedMetrics (list) --

          An array of objects that describe a projected utilization metric.

          • (dict) --

            Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance.

            • name (string) --

              The name of the projected utilization metric.

              Note

              Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .

            • timestamps (list) --

              The time stamps of the projected utilization metric.

              • (datetime) --
            • values (list) --

              The values of the projected utilization metrics.

              • (float) --

Exceptions

get_enrollment_status()

Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.

If the account is the master account of an organization, this action also confirms the enrollment status of member accounts within the organization.

See also: AWS API Documentation

Request Syntax

response = client.get_enrollment_status()
Return type
dict
Returns
Response Syntax
{
    'status': 'Active'|'Inactive'|'Pending'|'Failed',
    'statusReason': 'string',
    'memberAccountsEnrolled': True|False
}

Response Structure

  • (dict) --
    • status (string) --

      The enrollment status of the account.

    • statusReason (string) --

      The reason for the enrollment status of the account.

      For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

    • memberAccountsEnrolled (boolean) --

      Confirms the enrollment status of member accounts within the organization, if the account is a master account of an organization.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_recommendation_summaries(**kwargs)

Returns the optimization findings for an account.

For example, it returns the number of Amazon EC2 instances in an account that are under-provisioned, over-provisioned, or optimized. It also returns the number of Auto Scaling groups in an account that are not optimized, or optimized.

See also: AWS API Documentation

Request Syntax

response = client.get_recommendation_summaries(
    accountIds=[
        'string',
    ],
    nextToken='string',
    maxResults=123
)
Parameters
  • accountIds (list) --

    The IDs of the AWS accounts for which to return recommendation summaries.

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

    Only one account ID can be specified per request.

    • (string) --
  • nextToken (string) -- The token to advance to the next page of recommendation summaries.
  • maxResults (integer) --

    The maximum number of recommendation summaries to return with a single request.

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

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'recommendationSummaries': [
        {
            'summaries': [
                {
                    'name': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
                    'value': 123.0
                },
            ],
            'recommendationResourceType': 'Ec2Instance'|'AutoScalingGroup',
            'accountId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token to use to advance to the next page of recommendation summaries.

      This value is null when there are no more pages of recommendation summaries to return.

    • recommendationSummaries (list) --

      An array of objects that summarize a recommendation.

      • (dict) --

        A summary of a recommendation.

        • summaries (list) --

          An array of objects that describe a recommendation summary.

          • (dict) --

            The summary of a recommendation.

            • name (string) --

              The finding classification of the recommendation.

            • value (float) --

              The value of the recommendation summary.

        • recommendationResourceType (string) --

          The resource type of the recommendation.

        • accountId (string) --

          The AWS account ID of the recommendation summary.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
update_enrollment_status(**kwargs)

Updates the enrollment (opt in) status of an account to the AWS Compute Optimizer service.

If the account is a master account of an organization, this action can also be used to enroll member accounts within the organization.

See also: AWS API Documentation

Request Syntax

response = client.update_enrollment_status(
    status='Active'|'Inactive'|'Pending'|'Failed',
    includeMemberAccounts=True|False
)
Parameters
  • status (string) --

    [REQUIRED]

    The new enrollment status of the account.

    Accepted options are Active or Inactive . You will get an error if Pending or Failed are specified.

  • includeMemberAccounts (boolean) -- Indicates whether to enroll member accounts of the organization if the your account is the master account of an organization.
Return type

dict

Returns

Response Syntax

{
    'status': 'Active'|'Inactive'|'Pending'|'Failed',
    'statusReason': 'string'
}

Response Structure

  • (dict) --

    • status (string) --

      The enrollment status of the account.

    • statusReason (string) --

      The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class ComputeOptimizer.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ComputeOptimizer.Client.exceptions.InternalServerException

An internal error has occurred. Try your call again.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An internal error has occurred. Try your call again.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ComputeOptimizer.Client.exceptions.InvalidParameterValueException

An invalid or out-of-range value was supplied for the input parameter.

Example

try:
  ...
except client.exceptions.InvalidParameterValueException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An invalid or out-of-range value was supplied for the input parameter.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ComputeOptimizer.Client.exceptions.LimitExceededException

The request exceeds a limit of the service.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request exceeds a limit of the service.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ComputeOptimizer.Client.exceptions.MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

Example

try:
  ...
except client.exceptions.MissingAuthenticationToken as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ComputeOptimizer.Client.exceptions.OptInRequiredException

The account is not opted in to AWS Compute Optimizer.

Example

try:
  ...
except client.exceptions.OptInRequiredException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The account is not opted in to AWS Compute Optimizer.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ComputeOptimizer.Client.exceptions.ResourceNotFoundException

A resource that is required for the action doesn't exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A resource that is required for the action doesn't exist.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ComputeOptimizer.Client.exceptions.ServiceUnavailableException

The request has failed due to a temporary failure of the server.

Example

try:
  ...
except client.exceptions.ServiceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request has failed due to a temporary failure of the server.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ComputeOptimizer.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: