AWS Outposts

2026/09/10 - AWS Outposts - 10 updated api methods

Changes  Added fields to identify Outpost generation and rack scaling configuration on Outpost and CatalogItem resources.

CreateOutpost (updated) Link ¶
Changes (response)
{'Outpost': {'Generation': 'GENERATION_2 | GENERATION_1',
             'RackScalingType': 'SINGLE_RACK | MULTI_RACK'}}

Creates an Outpost.

You can specify either an Availability one or an AZ ID.

See also: AWS API Documentation

Request Syntax

client.create_outpost(
    Name='string',
    Description='string',
    SiteId='string',
    AvailabilityZone='string',
    AvailabilityZoneId='string',
    Tags={
        'string': 'string'
    },
    SupportedHardwareType='RACK'|'SERVER'
)
type Name:

string

param Name:

[REQUIRED]

The name of the Outpost.

type Description:

string

param Description:

The description of the Outpost.

type SiteId:

string

param SiteId:

[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the site.

type AvailabilityZone:

string

param AvailabilityZone:

The Availability Zone.

type AvailabilityZoneId:

string

param AvailabilityZoneId:

The ID of the Availability Zone.

type Tags:

dict

param Tags:

The tags to apply to the Outpost.

  • (string) --

    • (string) --

type SupportedHardwareType:

string

param SupportedHardwareType:

The type of hardware for this Outpost.

rtype:

dict

returns:

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'SupportedHardwareType': 'RACK'|'SERVER',
        'Generation': 'GENERATION_2'|'GENERATION_1',
        'RackScalingType': 'SINGLE_RACK'|'MULTI_RACK'
    }
}

Response Structure

  • (dict) --

    • Outpost (dict) --

      Information about an Outpost.

      • OutpostId (string) --

        The ID of the Outpost.

      • OwnerId (string) --

        The Amazon Web Services account ID of the Outpost owner.

      • OutpostArn (string) --

        The Amazon Resource Name (ARN) of the Outpost.

      • SiteId (string) --

        The ID of the site.

      • Name (string) --

        The name of the Outpost.

      • Description (string) --

        The description of the Outpost.

      • LifeCycleStatus (string) --

        The life cycle status.

      • AvailabilityZone (string) --

        The Availability Zone.

      • AvailabilityZoneId (string) --

        The ID of the Availability Zone.

      • Tags (dict) --

        The Outpost tags.

        • (string) --

          • (string) --

      • SiteArn (string) --

        The Amazon Resource Name (ARN) of the site.

      • SupportedHardwareType (string) --

        The hardware type.

      • Generation (string) --

        The Outpost generation. Valid values are GENERATION_1 for first-generation rack deployments and GENERATION_2 for second-generation rack deployments.

      • RackScalingType (string) --

        The rack scaling type. Valid values are SINGLE_RACK for single-rack Outposts and MULTI_RACK for multi-rack Outposts that can expand across multiple racks.

CreateQuote (updated) Link ¶
Changes (request, response)
Request
{'RequestedConstraints': {'QuoteConstraintType': {'RACK_SPACE_CONSTRAINED'}}}
Response
{'Quote': {'RequestedConstraints': {'QuoteConstraintType': {'RACK_SPACE_CONSTRAINED'}}}}

Creates a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity. You can optionally associate the quote with an existing Outpost or create a standalone quote by specifying only the country code and requested capacities.

See also: AWS API Documentation

Request Syntax

client.create_quote(
    OutpostIdentifier='string',
    CountryCode='string',
    RequestedCapacities=[
        {
            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
            'Unit': 'string',
            'Quantity': ...
        },
    ],
    RequestedConstraints=[
        {
            'QuoteConstraintType': 'RACK_MAXIMUM'|'RACK_MAX_POWER_KVA'|'RACK_MAX_WEIGHT_LBS'|'RACK_SPACE_CONSTRAINED',
            'Value': 'string'
        },
    ],
    RequestedPaymentOptions=[
        'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
    ],
    RequestedPaymentTerms=[
        'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
    ],
    Description='string'
)
type OutpostIdentifier:

string

param OutpostIdentifier:

The ID or ARN of the Outpost to associate with the quote. If not specified, the quote is created without an Outpost association.

type CountryCode:

string

param CountryCode:

[REQUIRED]

The country code for the Outpost site location.

type RequestedCapacities:

list

param RequestedCapacities:

[REQUIRED]

The capacity requirements for the quote. Each entry specifies a capacity type (such as Amazon EC2), the unit, and the quantity. For Amazon EC2, the quantity is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, the quantity is the total desired end-state capacity of the Outpost.

  • (dict) --

    A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

    • QuoteCapacityType (string) --

      The type of capacity. Valid values are EC2, EBS, and S3.

    • Unit (string) --

      The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

    • Quantity (float) --

      The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

type RequestedConstraints:

list

param RequestedConstraints:

The physical constraints for the quote, such as maximum number of racks, maximum power draw per rack, or maximum weight per rack.

  • (dict) --

    A physical constraint for a quote.

    • QuoteConstraintType (string) --

      The type of constraint. Valid values are RACK_MAXIMUM, RACK_MAX_POWER_KVA, RACK_MAX_WEIGHT_LBS, and RACK_SPACE_CONSTRAINED.

    • Value (string) --

      The value of the constraint.

type RequestedPaymentOptions:

list

param RequestedPaymentOptions:

The payment options to include in the quote pricing. If not specified, all available payment options are returned.

  • (string) --

type RequestedPaymentTerms:

list

param RequestedPaymentTerms:

The payment terms to include in the quote pricing. If not specified, all available payment terms are returned.

  • (string) --

type Description:

string

param Description:

A description for the quote.

rtype:

dict

returns:

Response Syntax

{
    'Quote': {
        'QuoteId': 'string',
        'AccountId': 'string',
        'QuoteStatus': 'CREATED'|'ORDER_SUBMITTED'|'EXPIRED',
        'StatusMessage': 'string',
        'OutpostArn': 'string',
        'CountryCode': 'string',
        'RequestedCapacities': [
            {
                'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                'Unit': 'string',
                'Quantity': ...
            },
        ],
        'RequestedConstraints': [
            {
                'QuoteConstraintType': 'RACK_MAXIMUM'|'RACK_MAX_POWER_KVA'|'RACK_MAX_WEIGHT_LBS'|'RACK_SPACE_CONSTRAINED',
                'Value': 'string'
            },
        ],
        'RequestedPaymentOptions': [
            'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
        ],
        'RequestedPaymentTerms': [
            'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
        ],
        'QuoteOptions': [
            {
                'QuoteOptionIdentifier': 'string',
                'Capacities': [
                    {
                        'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                        'Unit': 'string',
                        'Quantity': ...
                    },
                ],
                'CapacitySummary': {
                    'ExistingCapacities': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ],
                    'FinalCapacities': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ],
                    'CapacityChange': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ]
                },
                'Specifications': [
                    {
                        'QuoteSpecificationType': 'UPDATED_RACK'|'NEW_RACK'|'EXISTING_RACK'|'SERVER',
                        'ExistingRackSpecificationDetails': {
                            'RackId': 'string',
                            'RackUse': 'NETWORKING'|'COMPUTE',
                            'RackPowerDrawKva': ...,
                            'RackWeightLbs': ...,
                            'RackHeightInches': ...,
                            'RackWidthInches': ...,
                            'RackDepthInches': ...,
                            'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                            'EC2Capacities': [
                                {
                                    'Family': 'string',
                                    'MaxSize': 'string',
                                    'Quantity': 'string'
                                },
                            ]
                        },
                        'FinalRackSpecificationDetails': {
                            'RackId': 'string',
                            'RackUse': 'NETWORKING'|'COMPUTE',
                            'RackPowerDrawKva': ...,
                            'RackWeightLbs': ...,
                            'RackHeightInches': ...,
                            'RackWidthInches': ...,
                            'RackDepthInches': ...,
                            'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                            'EC2Capacities': [
                                {
                                    'Family': 'string',
                                    'MaxSize': 'string',
                                    'Quantity': 'string'
                                },
                            ]
                        },
                        'ServerSpecificationDetails': {
                            'ServerPowerDrawKva': ...,
                            'ServerWeightLbs': ...,
                            'ServerHeightInches': ...,
                            'ServerWidthInches': ...,
                            'ServerDepthInches': ...,
                            'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                            'EC2Capacities': [
                                {
                                    'Family': 'string',
                                    'MaxSize': 'string',
                                    'Quantity': 'string'
                                },
                            ]
                        }
                    },
                ],
                'PricingOptions': [
                    {
                        'PricingType': 'SUBSCRIPTION',
                        'SubscriptionPricingDetails': {
                            'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
                            'PaymentTerm': 'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
                            'UpfrontPrice': ...,
                            'MonthlyRecurringPrice': ...,
                            'Currency': 'USD'
                        }
                    },
                ]
            },
        ],
        'OrderingRequirements': [
            {
                'StatusMessage': 'string',
                'OrderingRequirementType': 'OUTPOST_ACTIVE_CHECK_ERROR'|'MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR'|'VALID_ZIP_CODE_CHECK_ERROR'|'RACK_PHYSICAL_PROPERTIES_CHECK_ERROR'|'OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR'|'SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR'|'COUNTRY_CODE_MISMATCH_CHECK_ERROR'|'OUTPOST_GENERATION_MISMATCH_ERROR'|'UNSUPPORTED'|'OUTPOST_ID_MISSING_ON_QUOTE_ERROR'|'ENTERPRISE_SUPPORT_ERROR'|'SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR'|'SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR'|'SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR'|'OUTPOST_STATE_CHANGED_ERROR'|'OUTPOST_NOT_FOUND_ERROR'|'OUTPOST_RENEWAL_REQUIRED_ERROR',
                'Status': 'PASS'|'FAIL'|'EXEMPT'
            },
        ],
        'SubmittedOrderId': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'ExpirationDate': datetime(2015, 1, 1),
        'Description': 'string'
    }
}

Response Structure

  • (dict) --

    • Quote (dict) --

      Information about the quote.

      • QuoteId (string) --

        The ID of the quote.

      • AccountId (string) --

        The ID of the account that owns the quote.

      • QuoteStatus (string) --

        The status of the quote.

        • CREATED - The quote has been created and is available for review.

        • ORDER_SUBMITTED - An order has been submitted for the quote.

        • EXPIRED - The quote has expired and can no longer be used to submit an order.

      • StatusMessage (string) --

        A message about the status of the quote.

      • OutpostArn (string) --

        The ARN of the Outpost associated with the quote.

      • CountryCode (string) --

        The country code for the Outpost site location.

      • RequestedCapacities (list) --

        The capacity requirements specified in the quote request.

        • (dict) --

          A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

          • QuoteCapacityType (string) --

            The type of capacity. Valid values are EC2, EBS, and S3.

          • Unit (string) --

            The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

          • Quantity (float) --

            The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

      • RequestedConstraints (list) --

        The physical constraints specified in the quote request.

        • (dict) --

          A physical constraint for a quote.

          • QuoteConstraintType (string) --

            The type of constraint. Valid values are RACK_MAXIMUM, RACK_MAX_POWER_KVA, RACK_MAX_WEIGHT_LBS, and RACK_SPACE_CONSTRAINED.

          • Value (string) --

            The value of the constraint.

      • RequestedPaymentOptions (list) --

        The payment options specified in the quote request.

        • (string) --

      • RequestedPaymentTerms (list) --

        The payment terms specified in the quote request.

        • (string) --

      • QuoteOptions (list) --

        The configuration and pricing options for the quote. Each option includes capacity details, physical specifications, and pricing information.

        • (dict) --

          A configuration and pricing option for a quote. Each option includes the capacity breakdown, physical specifications for the racks or servers, and pricing details.

          • QuoteOptionIdentifier (string) --

            The ID of the quote option.

          • Capacities (list) --

            The capacities included in this quote option.

            • (dict) --

              A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

              • QuoteCapacityType (string) --

                The type of capacity. Valid values are EC2, EBS, and S3.

              • Unit (string) --

                The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

              • Quantity (float) --

                The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

          • CapacitySummary (dict) --

            A summary of the existing, final, and changed capacity for this quote option.

            • ExistingCapacities (list) --

              The existing capacities on the Outpost before the quote is fulfilled.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

            • FinalCapacities (list) --

              The final capacities on the Outpost after the quote is fulfilled.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

            • CapacityChange (list) --

              The change in capacity between the existing and final state.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

          • Specifications (list) --

            The physical specifications for the racks or servers in this quote option.

            • (dict) --

              A physical specification for a quote option. Describes the rack or server configuration that would be deployed.

              • QuoteSpecificationType (string) --

                The type of specification. Valid values are NEW_RACK, UPDATED_RACK, EXISTING_RACK, and SERVER.

              • ExistingRackSpecificationDetails (dict) --

                The existing rack specification details, if the specification type is UPDATED_RACK or EXISTING_RACK.

                • RackId (string) --

                  The ID of the rack.

                • RackUse (string) --

                  The use of the rack. Valid values are COMPUTE and NETWORKING.

                • RackPowerDrawKva (float) --

                  The maximum power draw of the rack in kVA.

                • RackWeightLbs (float) --

                  The weight of the rack in pounds.

                • RackHeightInches (float) --

                  The height of the rack in inches.

                • RackWidthInches (float) --

                  The width of the rack in inches.

                • RackDepthInches (float) --

                  The depth of the rack in inches.

                • RackUnitHeight (string) --

                  The rack unit height.

                  • HEIGHT_42U - 42 rack units.

                  • HEIGHT_2U - 2 rack units.

                  • HEIGHT_1U - 1 rack unit.

                • EC2Capacities (list) --

                  The Amazon EC2 capacities for the rack.

                  • (dict) --

                    Information about EC2 capacity.

                    • Family (string) --

                      The family of the EC2 capacity.

                    • MaxSize (string) --

                      The maximum size of the EC2 capacity.

                    • Quantity (string) --

                      The quantity of the EC2 capacity.

              • FinalRackSpecificationDetails (dict) --

                The final rack specification details after the quote is fulfilled.

                • RackId (string) --

                  The ID of the rack.

                • RackUse (string) --

                  The use of the rack. Valid values are COMPUTE and NETWORKING.

                • RackPowerDrawKva (float) --

                  The maximum power draw of the rack in kVA.

                • RackWeightLbs (float) --

                  The weight of the rack in pounds.

                • RackHeightInches (float) --

                  The height of the rack in inches.

                • RackWidthInches (float) --

                  The width of the rack in inches.

                • RackDepthInches (float) --

                  The depth of the rack in inches.

                • RackUnitHeight (string) --

                  The rack unit height.

                  • HEIGHT_42U - 42 rack units.

                  • HEIGHT_2U - 2 rack units.

                  • HEIGHT_1U - 1 rack unit.

                • EC2Capacities (list) --

                  The Amazon EC2 capacities for the rack.

                  • (dict) --

                    Information about EC2 capacity.

                    • Family (string) --

                      The family of the EC2 capacity.

                    • MaxSize (string) --

                      The maximum size of the EC2 capacity.

                    • Quantity (string) --

                      The quantity of the EC2 capacity.

              • ServerSpecificationDetails (dict) --

                The server specification details, if the specification type is SERVER.

                • ServerPowerDrawKva (float) --

                  The maximum power draw of the server in kVA.

                • ServerWeightLbs (float) --

                  The weight of the server in pounds.

                • ServerHeightInches (float) --

                  The height of the server in inches.

                • ServerWidthInches (float) --

                  The width of the server in inches.

                • ServerDepthInches (float) --

                  The depth of the server in inches.

                • RackUnitHeight (string) --

                  The rack unit height of the server.

                  • HEIGHT_2U - 2 rack units.

                  • HEIGHT_1U - 1 rack unit.

                • EC2Capacities (list) --

                  The Amazon EC2 capacities for the server.

                  • (dict) --

                    Information about EC2 capacity.

                    • Family (string) --

                      The family of the EC2 capacity.

                    • MaxSize (string) --

                      The maximum size of the EC2 capacity.

                    • Quantity (string) --

                      The quantity of the EC2 capacity.

          • PricingOptions (list) --

            The pricing options for this quote option.

            • (dict) --

              A pricing option for the specified Outpost.

              • PricingType (string) --

                The type of pricing model.

              • SubscriptionPricingDetails (dict) --

                The subscription pricing details for this pricing option.

                • PaymentOption (string) --

                  The payment option.

                • PaymentTerm (string) --

                  The payment term.

                • UpfrontPrice (float) --

                  The upfront price.

                • MonthlyRecurringPrice (float) --

                  The monthly recurring price.

                • Currency (string) --

                  The currency of the price. Currently only USD is supported.

      • OrderingRequirements (list) --

        The requirements that must be met before an order can be submitted for the quote.

        • (dict) --

          A requirement that must be met before an order can be submitted for a quote.

          • StatusMessage (string) --

            A message about the ordering requirement.

          • OrderingRequirementType (string) --

            The type of ordering requirement. Indicates which check failed or passed.

            • OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state.

            • MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached.

            • VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code.

            • RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements.

            • OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address.

            • SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address.

            • COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country.

            • OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration.

            • OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order.

            • ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required.

            • SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name.

            • SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number.

            • SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information.

            • OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created.

            • OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found.

            • OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted.

            • UNSUPPORTED - The requirement type is not recognized.

          • Status (string) --

            The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT.

      • SubmittedOrderId (string) --

        The ID of the order submitted for the quote.

      • CreatedDate (datetime) --

        The date the quote was created.

      • ExpirationDate (datetime) --

        The date the quote expires.

      • Description (string) --

        The description of the quote.

GetCatalogItem (updated) Link ¶
Changes (response)
{'CatalogItem': {'RackScalingType': 'SINGLE_RACK | MULTI_RACK'}}

Gets information about the specified catalog item.

See also: AWS API Documentation

Request Syntax

client.get_catalog_item(
    CatalogItemId='string'
)
type CatalogItemId:

string

param CatalogItemId:

[REQUIRED]

The ID of the catalog item.

rtype:

dict

returns:

Response Syntax

{
    'CatalogItem': {
        'CatalogItemId': 'string',
        'ItemStatus': 'AVAILABLE'|'DISCONTINUED',
        'EC2Capacities': [
            {
                'Family': 'string',
                'MaxSize': 'string',
                'Quantity': 'string'
            },
        ],
        'PowerKva': ...,
        'WeightLbs': 123,
        'SupportedUplinkGbps': [
            123,
        ],
        'SupportedStorage': [
            'EBS'|'S3',
        ],
        'RackScalingType': 'SINGLE_RACK'|'MULTI_RACK'
    }
}

Response Structure

  • (dict) --

    • CatalogItem (dict) --

      Information about this catalog item.

      • CatalogItemId (string) --

        The ID of the catalog item.

      • ItemStatus (string) --

        The status of a catalog item.

      • EC2Capacities (list) --

        Information about the EC2 capacity of an item.

        • (dict) --

          Information about EC2 capacity.

          • Family (string) --

            The family of the EC2 capacity.

          • MaxSize (string) --

            The maximum size of the EC2 capacity.

          • Quantity (string) --

            The quantity of the EC2 capacity.

      • PowerKva (float) --

        Information about the power draw of an item.

      • WeightLbs (integer) --

        The weight of the item in pounds.

      • SupportedUplinkGbps (list) --

        The uplink speed this catalog item requires for the connection to the Region.

        • (integer) --

      • SupportedStorage (list) --

        The supported storage options for the catalog item.

        • (string) --

      • RackScalingType (string) --

        The rack scaling type supported by the catalog item. Valid values are SINGLE_RACK and MULTI_RACK.

GetOutpost (updated) Link ¶
Changes (response)
{'Outpost': {'Generation': 'GENERATION_2 | GENERATION_1',
             'RackScalingType': 'SINGLE_RACK | MULTI_RACK'}}

Gets information about the specified Outpost.

See also: AWS API Documentation

Request Syntax

client.get_outpost(
    OutpostId='string'
)
type OutpostId:

string

param OutpostId:

[REQUIRED]

The ID or ARN of the Outpost.

rtype:

dict

returns:

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'SupportedHardwareType': 'RACK'|'SERVER',
        'Generation': 'GENERATION_2'|'GENERATION_1',
        'RackScalingType': 'SINGLE_RACK'|'MULTI_RACK'
    }
}

Response Structure

  • (dict) --

    • Outpost (dict) --

      Information about an Outpost.

      • OutpostId (string) --

        The ID of the Outpost.

      • OwnerId (string) --

        The Amazon Web Services account ID of the Outpost owner.

      • OutpostArn (string) --

        The Amazon Resource Name (ARN) of the Outpost.

      • SiteId (string) --

        The ID of the site.

      • Name (string) --

        The name of the Outpost.

      • Description (string) --

        The description of the Outpost.

      • LifeCycleStatus (string) --

        The life cycle status.

      • AvailabilityZone (string) --

        The Availability Zone.

      • AvailabilityZoneId (string) --

        The ID of the Availability Zone.

      • Tags (dict) --

        The Outpost tags.

        • (string) --

          • (string) --

      • SiteArn (string) --

        The Amazon Resource Name (ARN) of the site.

      • SupportedHardwareType (string) --

        The hardware type.

      • Generation (string) --

        The Outpost generation. Valid values are GENERATION_1 for first-generation rack deployments and GENERATION_2 for second-generation rack deployments.

      • RackScalingType (string) --

        The rack scaling type. Valid values are SINGLE_RACK for single-rack Outposts and MULTI_RACK for multi-rack Outposts that can expand across multiple racks.

GetQuote (updated) Link ¶
Changes (response)
{'Quote': {'RequestedConstraints': {'QuoteConstraintType': {'RACK_SPACE_CONSTRAINED'}}}}

Gets information about the specified quote.

See also: AWS API Documentation

Request Syntax

client.get_quote(
    QuoteIdentifier='string'
)
type QuoteIdentifier:

string

param QuoteIdentifier:

[REQUIRED]

The ID of the quote.

rtype:

dict

returns:

Response Syntax

{
    'Quote': {
        'QuoteId': 'string',
        'AccountId': 'string',
        'QuoteStatus': 'CREATED'|'ORDER_SUBMITTED'|'EXPIRED',
        'StatusMessage': 'string',
        'OutpostArn': 'string',
        'CountryCode': 'string',
        'RequestedCapacities': [
            {
                'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                'Unit': 'string',
                'Quantity': ...
            },
        ],
        'RequestedConstraints': [
            {
                'QuoteConstraintType': 'RACK_MAXIMUM'|'RACK_MAX_POWER_KVA'|'RACK_MAX_WEIGHT_LBS'|'RACK_SPACE_CONSTRAINED',
                'Value': 'string'
            },
        ],
        'RequestedPaymentOptions': [
            'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
        ],
        'RequestedPaymentTerms': [
            'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
        ],
        'QuoteOptions': [
            {
                'QuoteOptionIdentifier': 'string',
                'Capacities': [
                    {
                        'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                        'Unit': 'string',
                        'Quantity': ...
                    },
                ],
                'CapacitySummary': {
                    'ExistingCapacities': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ],
                    'FinalCapacities': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ],
                    'CapacityChange': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ]
                },
                'Specifications': [
                    {
                        'QuoteSpecificationType': 'UPDATED_RACK'|'NEW_RACK'|'EXISTING_RACK'|'SERVER',
                        'ExistingRackSpecificationDetails': {
                            'RackId': 'string',
                            'RackUse': 'NETWORKING'|'COMPUTE',
                            'RackPowerDrawKva': ...,
                            'RackWeightLbs': ...,
                            'RackHeightInches': ...,
                            'RackWidthInches': ...,
                            'RackDepthInches': ...,
                            'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                            'EC2Capacities': [
                                {
                                    'Family': 'string',
                                    'MaxSize': 'string',
                                    'Quantity': 'string'
                                },
                            ]
                        },
                        'FinalRackSpecificationDetails': {
                            'RackId': 'string',
                            'RackUse': 'NETWORKING'|'COMPUTE',
                            'RackPowerDrawKva': ...,
                            'RackWeightLbs': ...,
                            'RackHeightInches': ...,
                            'RackWidthInches': ...,
                            'RackDepthInches': ...,
                            'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                            'EC2Capacities': [
                                {
                                    'Family': 'string',
                                    'MaxSize': 'string',
                                    'Quantity': 'string'
                                },
                            ]
                        },
                        'ServerSpecificationDetails': {
                            'ServerPowerDrawKva': ...,
                            'ServerWeightLbs': ...,
                            'ServerHeightInches': ...,
                            'ServerWidthInches': ...,
                            'ServerDepthInches': ...,
                            'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                            'EC2Capacities': [
                                {
                                    'Family': 'string',
                                    'MaxSize': 'string',
                                    'Quantity': 'string'
                                },
                            ]
                        }
                    },
                ],
                'PricingOptions': [
                    {
                        'PricingType': 'SUBSCRIPTION',
                        'SubscriptionPricingDetails': {
                            'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
                            'PaymentTerm': 'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
                            'UpfrontPrice': ...,
                            'MonthlyRecurringPrice': ...,
                            'Currency': 'USD'
                        }
                    },
                ]
            },
        ],
        'OrderingRequirements': [
            {
                'StatusMessage': 'string',
                'OrderingRequirementType': 'OUTPOST_ACTIVE_CHECK_ERROR'|'MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR'|'VALID_ZIP_CODE_CHECK_ERROR'|'RACK_PHYSICAL_PROPERTIES_CHECK_ERROR'|'OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR'|'SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR'|'COUNTRY_CODE_MISMATCH_CHECK_ERROR'|'OUTPOST_GENERATION_MISMATCH_ERROR'|'UNSUPPORTED'|'OUTPOST_ID_MISSING_ON_QUOTE_ERROR'|'ENTERPRISE_SUPPORT_ERROR'|'SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR'|'SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR'|'SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR'|'OUTPOST_STATE_CHANGED_ERROR'|'OUTPOST_NOT_FOUND_ERROR'|'OUTPOST_RENEWAL_REQUIRED_ERROR',
                'Status': 'PASS'|'FAIL'|'EXEMPT'
            },
        ],
        'SubmittedOrderId': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'ExpirationDate': datetime(2015, 1, 1),
        'Description': 'string'
    }
}

Response Structure

  • (dict) --

    • Quote (dict) --

      Information about the quote.

      • QuoteId (string) --

        The ID of the quote.

      • AccountId (string) --

        The ID of the account that owns the quote.

      • QuoteStatus (string) --

        The status of the quote.

        • CREATED - The quote has been created and is available for review.

        • ORDER_SUBMITTED - An order has been submitted for the quote.

        • EXPIRED - The quote has expired and can no longer be used to submit an order.

      • StatusMessage (string) --

        A message about the status of the quote.

      • OutpostArn (string) --

        The ARN of the Outpost associated with the quote.

      • CountryCode (string) --

        The country code for the Outpost site location.

      • RequestedCapacities (list) --

        The capacity requirements specified in the quote request.

        • (dict) --

          A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

          • QuoteCapacityType (string) --

            The type of capacity. Valid values are EC2, EBS, and S3.

          • Unit (string) --

            The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

          • Quantity (float) --

            The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

      • RequestedConstraints (list) --

        The physical constraints specified in the quote request.

        • (dict) --

          A physical constraint for a quote.

          • QuoteConstraintType (string) --

            The type of constraint. Valid values are RACK_MAXIMUM, RACK_MAX_POWER_KVA, RACK_MAX_WEIGHT_LBS, and RACK_SPACE_CONSTRAINED.

          • Value (string) --

            The value of the constraint.

      • RequestedPaymentOptions (list) --

        The payment options specified in the quote request.

        • (string) --

      • RequestedPaymentTerms (list) --

        The payment terms specified in the quote request.

        • (string) --

      • QuoteOptions (list) --

        The configuration and pricing options for the quote. Each option includes capacity details, physical specifications, and pricing information.

        • (dict) --

          A configuration and pricing option for a quote. Each option includes the capacity breakdown, physical specifications for the racks or servers, and pricing details.

          • QuoteOptionIdentifier (string) --

            The ID of the quote option.

          • Capacities (list) --

            The capacities included in this quote option.

            • (dict) --

              A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

              • QuoteCapacityType (string) --

                The type of capacity. Valid values are EC2, EBS, and S3.

              • Unit (string) --

                The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

              • Quantity (float) --

                The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

          • CapacitySummary (dict) --

            A summary of the existing, final, and changed capacity for this quote option.

            • ExistingCapacities (list) --

              The existing capacities on the Outpost before the quote is fulfilled.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

            • FinalCapacities (list) --

              The final capacities on the Outpost after the quote is fulfilled.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

            • CapacityChange (list) --

              The change in capacity between the existing and final state.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

          • Specifications (list) --

            The physical specifications for the racks or servers in this quote option.

            • (dict) --

              A physical specification for a quote option. Describes the rack or server configuration that would be deployed.

              • QuoteSpecificationType (string) --

                The type of specification. Valid values are NEW_RACK, UPDATED_RACK, EXISTING_RACK, and SERVER.

              • ExistingRackSpecificationDetails (dict) --

                The existing rack specification details, if the specification type is UPDATED_RACK or EXISTING_RACK.

                • RackId (string) --

                  The ID of the rack.

                • RackUse (string) --

                  The use of the rack. Valid values are COMPUTE and NETWORKING.

                • RackPowerDrawKva (float) --

                  The maximum power draw of the rack in kVA.

                • RackWeightLbs (float) --

                  The weight of the rack in pounds.

                • RackHeightInches (float) --

                  The height of the rack in inches.

                • RackWidthInches (float) --

                  The width of the rack in inches.

                • RackDepthInches (float) --

                  The depth of the rack in inches.

                • RackUnitHeight (string) --

                  The rack unit height.

                  • HEIGHT_42U - 42 rack units.

                  • HEIGHT_2U - 2 rack units.

                  • HEIGHT_1U - 1 rack unit.

                • EC2Capacities (list) --

                  The Amazon EC2 capacities for the rack.

                  • (dict) --

                    Information about EC2 capacity.

                    • Family (string) --

                      The family of the EC2 capacity.

                    • MaxSize (string) --

                      The maximum size of the EC2 capacity.

                    • Quantity (string) --

                      The quantity of the EC2 capacity.

              • FinalRackSpecificationDetails (dict) --

                The final rack specification details after the quote is fulfilled.

                • RackId (string) --

                  The ID of the rack.

                • RackUse (string) --

                  The use of the rack. Valid values are COMPUTE and NETWORKING.

                • RackPowerDrawKva (float) --

                  The maximum power draw of the rack in kVA.

                • RackWeightLbs (float) --

                  The weight of the rack in pounds.

                • RackHeightInches (float) --

                  The height of the rack in inches.

                • RackWidthInches (float) --

                  The width of the rack in inches.

                • RackDepthInches (float) --

                  The depth of the rack in inches.

                • RackUnitHeight (string) --

                  The rack unit height.

                  • HEIGHT_42U - 42 rack units.

                  • HEIGHT_2U - 2 rack units.

                  • HEIGHT_1U - 1 rack unit.

                • EC2Capacities (list) --

                  The Amazon EC2 capacities for the rack.

                  • (dict) --

                    Information about EC2 capacity.

                    • Family (string) --

                      The family of the EC2 capacity.

                    • MaxSize (string) --

                      The maximum size of the EC2 capacity.

                    • Quantity (string) --

                      The quantity of the EC2 capacity.

              • ServerSpecificationDetails (dict) --

                The server specification details, if the specification type is SERVER.

                • ServerPowerDrawKva (float) --

                  The maximum power draw of the server in kVA.

                • ServerWeightLbs (float) --

                  The weight of the server in pounds.

                • ServerHeightInches (float) --

                  The height of the server in inches.

                • ServerWidthInches (float) --

                  The width of the server in inches.

                • ServerDepthInches (float) --

                  The depth of the server in inches.

                • RackUnitHeight (string) --

                  The rack unit height of the server.

                  • HEIGHT_2U - 2 rack units.

                  • HEIGHT_1U - 1 rack unit.

                • EC2Capacities (list) --

                  The Amazon EC2 capacities for the server.

                  • (dict) --

                    Information about EC2 capacity.

                    • Family (string) --

                      The family of the EC2 capacity.

                    • MaxSize (string) --

                      The maximum size of the EC2 capacity.

                    • Quantity (string) --

                      The quantity of the EC2 capacity.

          • PricingOptions (list) --

            The pricing options for this quote option.

            • (dict) --

              A pricing option for the specified Outpost.

              • PricingType (string) --

                The type of pricing model.

              • SubscriptionPricingDetails (dict) --

                The subscription pricing details for this pricing option.

                • PaymentOption (string) --

                  The payment option.

                • PaymentTerm (string) --

                  The payment term.

                • UpfrontPrice (float) --

                  The upfront price.

                • MonthlyRecurringPrice (float) --

                  The monthly recurring price.

                • Currency (string) --

                  The currency of the price. Currently only USD is supported.

      • OrderingRequirements (list) --

        The requirements that must be met before an order can be submitted for the quote.

        • (dict) --

          A requirement that must be met before an order can be submitted for a quote.

          • StatusMessage (string) --

            A message about the ordering requirement.

          • OrderingRequirementType (string) --

            The type of ordering requirement. Indicates which check failed or passed.

            • OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state.

            • MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached.

            • VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code.

            • RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements.

            • OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address.

            • SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address.

            • COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country.

            • OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration.

            • OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order.

            • ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required.

            • SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name.

            • SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number.

            • SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information.

            • OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created.

            • OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found.

            • OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted.

            • UNSUPPORTED - The requirement type is not recognized.

          • Status (string) --

            The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT.

      • SubmittedOrderId (string) --

        The ID of the order submitted for the quote.

      • CreatedDate (datetime) --

        The date the quote was created.

      • ExpirationDate (datetime) --

        The date the quote expires.

      • Description (string) --

        The description of the quote.

ListCatalogItems (updated) Link ¶
Changes (response)
{'CatalogItems': {'RackScalingType': 'SINGLE_RACK | MULTI_RACK'}}

Lists the items in the catalog.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

See also: AWS API Documentation

Request Syntax

client.list_catalog_items(
    NextToken='string',
    MaxResults=123,
    ItemClassFilter=[
        'RACK'|'SERVER',
    ],
    SupportedStorageFilter=[
        'EBS'|'S3',
    ],
    EC2FamilyFilter=[
        'string',
    ]
)
type NextToken:

string

param NextToken:

The pagination token.

type MaxResults:

integer

param MaxResults:

The maximum page size.

type ItemClassFilter:

list

param ItemClassFilter:

Filters the results by item class.

  • (string) --

type SupportedStorageFilter:

list

param SupportedStorageFilter:

Filters the results by storage option.

  • (string) --

type EC2FamilyFilter:

list

param EC2FamilyFilter:

Filters the results by EC2 family (for example, M5).

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'CatalogItems': [
        {
            'CatalogItemId': 'string',
            'ItemStatus': 'AVAILABLE'|'DISCONTINUED',
            'EC2Capacities': [
                {
                    'Family': 'string',
                    'MaxSize': 'string',
                    'Quantity': 'string'
                },
            ],
            'PowerKva': ...,
            'WeightLbs': 123,
            'SupportedUplinkGbps': [
                123,
            ],
            'SupportedStorage': [
                'EBS'|'S3',
            ],
            'RackScalingType': 'SINGLE_RACK'|'MULTI_RACK'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CatalogItems (list) --

      Information about the catalog items.

      • (dict) --

        Information about a catalog item.

        • CatalogItemId (string) --

          The ID of the catalog item.

        • ItemStatus (string) --

          The status of a catalog item.

        • EC2Capacities (list) --

          Information about the EC2 capacity of an item.

          • (dict) --

            Information about EC2 capacity.

            • Family (string) --

              The family of the EC2 capacity.

            • MaxSize (string) --

              The maximum size of the EC2 capacity.

            • Quantity (string) --

              The quantity of the EC2 capacity.

        • PowerKva (float) --

          Information about the power draw of an item.

        • WeightLbs (integer) --

          The weight of the item in pounds.

        • SupportedUplinkGbps (list) --

          The uplink speed this catalog item requires for the connection to the Region.

          • (integer) --

        • SupportedStorage (list) --

          The supported storage options for the catalog item.

          • (string) --

        • RackScalingType (string) --

          The rack scaling type supported by the catalog item. Valid values are SINGLE_RACK and MULTI_RACK.

    • NextToken (string) --

      The pagination token.

ListOutposts (updated) Link ¶
Changes (response)
{'Outposts': {'Generation': 'GENERATION_2 | GENERATION_1',
              'RackScalingType': 'SINGLE_RACK | MULTI_RACK'}}

Lists the Outposts for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

See also: AWS API Documentation

Request Syntax

client.list_outposts(
    NextToken='string',
    MaxResults=123,
    LifeCycleStatusFilter=[
        'string',
    ],
    AvailabilityZoneFilter=[
        'string',
    ],
    AvailabilityZoneIdFilter=[
        'string',
    ]
)
type NextToken:

string

param NextToken:

The pagination token.

type MaxResults:

integer

param MaxResults:

The maximum page size.

type LifeCycleStatusFilter:

list

param LifeCycleStatusFilter:

Filters the results by the lifecycle status.

  • (string) --

    The life cycle status.

type AvailabilityZoneFilter:

list

param AvailabilityZoneFilter:

Filters the results by Availability Zone (for example, us-east-1a).

  • (string) --

    The Availability Zone.

type AvailabilityZoneIdFilter:

list

param AvailabilityZoneIdFilter:

Filters the results by AZ ID (for example, use1-az1).

  • (string) --

    The ID of the Availability Zone.

rtype:

dict

returns:

Response Syntax

{
    'Outposts': [
        {
            'OutpostId': 'string',
            'OwnerId': 'string',
            'OutpostArn': 'string',
            'SiteId': 'string',
            'Name': 'string',
            'Description': 'string',
            'LifeCycleStatus': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'Tags': {
                'string': 'string'
            },
            'SiteArn': 'string',
            'SupportedHardwareType': 'RACK'|'SERVER',
            'Generation': 'GENERATION_2'|'GENERATION_1',
            'RackScalingType': 'SINGLE_RACK'|'MULTI_RACK'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Outposts (list) --

      Information about the Outposts.

      • (dict) --

        Information about an Outpost.

        • OutpostId (string) --

          The ID of the Outpost.

        • OwnerId (string) --

          The Amazon Web Services account ID of the Outpost owner.

        • OutpostArn (string) --

          The Amazon Resource Name (ARN) of the Outpost.

        • SiteId (string) --

          The ID of the site.

        • Name (string) --

          The name of the Outpost.

        • Description (string) --

          The description of the Outpost.

        • LifeCycleStatus (string) --

          The life cycle status.

        • AvailabilityZone (string) --

          The Availability Zone.

        • AvailabilityZoneId (string) --

          The ID of the Availability Zone.

        • Tags (dict) --

          The Outpost tags.

          • (string) --

            • (string) --

        • SiteArn (string) --

          The Amazon Resource Name (ARN) of the site.

        • SupportedHardwareType (string) --

          The hardware type.

        • Generation (string) --

          The Outpost generation. Valid values are GENERATION_1 for first-generation rack deployments and GENERATION_2 for second-generation rack deployments.

        • RackScalingType (string) --

          The rack scaling type. Valid values are SINGLE_RACK for single-rack Outposts and MULTI_RACK for multi-rack Outposts that can expand across multiple racks.

    • NextToken (string) --

      The pagination token.

ListQuotes (updated) Link ¶
Changes (response)
{'Quotes': {'RequestedConstraints': {'QuoteConstraintType': {'RACK_SPACE_CONSTRAINED'}}}}

Lists the quotes for your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_quotes(
    NextToken='string',
    MaxResults=123
)
type NextToken:

string

param NextToken:

The pagination token.

type MaxResults:

integer

param MaxResults:

The maximum page size.

rtype:

dict

returns:

Response Syntax

{
    'Quotes': [
        {
            'QuoteId': 'string',
            'AccountId': 'string',
            'QuoteStatus': 'CREATED'|'ORDER_SUBMITTED'|'EXPIRED',
            'StatusMessage': 'string',
            'OutpostArn': 'string',
            'CountryCode': 'string',
            'RequestedCapacities': [
                {
                    'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                    'Unit': 'string',
                    'Quantity': ...
                },
            ],
            'RequestedConstraints': [
                {
                    'QuoteConstraintType': 'RACK_MAXIMUM'|'RACK_MAX_POWER_KVA'|'RACK_MAX_WEIGHT_LBS'|'RACK_SPACE_CONSTRAINED',
                    'Value': 'string'
                },
            ],
            'RequestedPaymentOptions': [
                'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
            ],
            'RequestedPaymentTerms': [
                'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
            ],
            'QuoteOptions': [
                {
                    'QuoteOptionIdentifier': 'string',
                    'Capacities': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ],
                    'CapacitySummary': {
                        'ExistingCapacities': [
                            {
                                'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                                'Unit': 'string',
                                'Quantity': ...
                            },
                        ],
                        'FinalCapacities': [
                            {
                                'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                                'Unit': 'string',
                                'Quantity': ...
                            },
                        ],
                        'CapacityChange': [
                            {
                                'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                                'Unit': 'string',
                                'Quantity': ...
                            },
                        ]
                    },
                    'Specifications': [
                        {
                            'QuoteSpecificationType': 'UPDATED_RACK'|'NEW_RACK'|'EXISTING_RACK'|'SERVER',
                            'ExistingRackSpecificationDetails': {
                                'RackId': 'string',
                                'RackUse': 'NETWORKING'|'COMPUTE',
                                'RackPowerDrawKva': ...,
                                'RackWeightLbs': ...,
                                'RackHeightInches': ...,
                                'RackWidthInches': ...,
                                'RackDepthInches': ...,
                                'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                                'EC2Capacities': [
                                    {
                                        'Family': 'string',
                                        'MaxSize': 'string',
                                        'Quantity': 'string'
                                    },
                                ]
                            },
                            'FinalRackSpecificationDetails': {
                                'RackId': 'string',
                                'RackUse': 'NETWORKING'|'COMPUTE',
                                'RackPowerDrawKva': ...,
                                'RackWeightLbs': ...,
                                'RackHeightInches': ...,
                                'RackWidthInches': ...,
                                'RackDepthInches': ...,
                                'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                                'EC2Capacities': [
                                    {
                                        'Family': 'string',
                                        'MaxSize': 'string',
                                        'Quantity': 'string'
                                    },
                                ]
                            },
                            'ServerSpecificationDetails': {
                                'ServerPowerDrawKva': ...,
                                'ServerWeightLbs': ...,
                                'ServerHeightInches': ...,
                                'ServerWidthInches': ...,
                                'ServerDepthInches': ...,
                                'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                                'EC2Capacities': [
                                    {
                                        'Family': 'string',
                                        'MaxSize': 'string',
                                        'Quantity': 'string'
                                    },
                                ]
                            }
                        },
                    ],
                    'PricingOptions': [
                        {
                            'PricingType': 'SUBSCRIPTION',
                            'SubscriptionPricingDetails': {
                                'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
                                'PaymentTerm': 'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
                                'UpfrontPrice': ...,
                                'MonthlyRecurringPrice': ...,
                                'Currency': 'USD'
                            }
                        },
                    ]
                },
            ],
            'SubmittedOrderId': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'ExpirationDate': datetime(2015, 1, 1),
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Quotes (list) --

      Information about the quotes.

      • (dict) --

        Summary information about a quote.

        • QuoteId (string) --

          The ID of the quote.

        • AccountId (string) --

          The ID of the account that owns the quote.

        • QuoteStatus (string) --

          The status of the quote.

        • StatusMessage (string) --

          A message about the status of the quote.

        • OutpostArn (string) --

          The ARN of the Outpost associated with the quote.

        • CountryCode (string) --

          The country code for the Outpost site location.

        • RequestedCapacities (list) --

          The capacity requirements specified in the quote request.

          • (dict) --

            A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

            • QuoteCapacityType (string) --

              The type of capacity. Valid values are EC2, EBS, and S3.

            • Unit (string) --

              The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

            • Quantity (float) --

              The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

        • RequestedConstraints (list) --

          The physical constraints specified in the quote request.

          • (dict) --

            A physical constraint for a quote.

            • QuoteConstraintType (string) --

              The type of constraint. Valid values are RACK_MAXIMUM, RACK_MAX_POWER_KVA, RACK_MAX_WEIGHT_LBS, and RACK_SPACE_CONSTRAINED.

            • Value (string) --

              The value of the constraint.

        • RequestedPaymentOptions (list) --

          The payment options specified in the quote request.

          • (string) --

        • RequestedPaymentTerms (list) --

          The payment terms specified in the quote request.

          • (string) --

        • QuoteOptions (list) --

          The configuration and pricing options for the quote.

          • (dict) --

            A configuration and pricing option for a quote. Each option includes the capacity breakdown, physical specifications for the racks or servers, and pricing details.

            • QuoteOptionIdentifier (string) --

              The ID of the quote option.

            • Capacities (list) --

              The capacities included in this quote option.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

            • CapacitySummary (dict) --

              A summary of the existing, final, and changed capacity for this quote option.

              • ExistingCapacities (list) --

                The existing capacities on the Outpost before the quote is fulfilled.

                • (dict) --

                  A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                  • QuoteCapacityType (string) --

                    The type of capacity. Valid values are EC2, EBS, and S3.

                  • Unit (string) --

                    The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                  • Quantity (float) --

                    The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

              • FinalCapacities (list) --

                The final capacities on the Outpost after the quote is fulfilled.

                • (dict) --

                  A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                  • QuoteCapacityType (string) --

                    The type of capacity. Valid values are EC2, EBS, and S3.

                  • Unit (string) --

                    The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                  • Quantity (float) --

                    The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

              • CapacityChange (list) --

                The change in capacity between the existing and final state.

                • (dict) --

                  A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                  • QuoteCapacityType (string) --

                    The type of capacity. Valid values are EC2, EBS, and S3.

                  • Unit (string) --

                    The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                  • Quantity (float) --

                    The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

            • Specifications (list) --

              The physical specifications for the racks or servers in this quote option.

              • (dict) --

                A physical specification for a quote option. Describes the rack or server configuration that would be deployed.

                • QuoteSpecificationType (string) --

                  The type of specification. Valid values are NEW_RACK, UPDATED_RACK, EXISTING_RACK, and SERVER.

                • ExistingRackSpecificationDetails (dict) --

                  The existing rack specification details, if the specification type is UPDATED_RACK or EXISTING_RACK.

                  • RackId (string) --

                    The ID of the rack.

                  • RackUse (string) --

                    The use of the rack. Valid values are COMPUTE and NETWORKING.

                  • RackPowerDrawKva (float) --

                    The maximum power draw of the rack in kVA.

                  • RackWeightLbs (float) --

                    The weight of the rack in pounds.

                  • RackHeightInches (float) --

                    The height of the rack in inches.

                  • RackWidthInches (float) --

                    The width of the rack in inches.

                  • RackDepthInches (float) --

                    The depth of the rack in inches.

                  • RackUnitHeight (string) --

                    The rack unit height.

                    • HEIGHT_42U - 42 rack units.

                    • HEIGHT_2U - 2 rack units.

                    • HEIGHT_1U - 1 rack unit.

                  • EC2Capacities (list) --

                    The Amazon EC2 capacities for the rack.

                    • (dict) --

                      Information about EC2 capacity.

                      • Family (string) --

                        The family of the EC2 capacity.

                      • MaxSize (string) --

                        The maximum size of the EC2 capacity.

                      • Quantity (string) --

                        The quantity of the EC2 capacity.

                • FinalRackSpecificationDetails (dict) --

                  The final rack specification details after the quote is fulfilled.

                  • RackId (string) --

                    The ID of the rack.

                  • RackUse (string) --

                    The use of the rack. Valid values are COMPUTE and NETWORKING.

                  • RackPowerDrawKva (float) --

                    The maximum power draw of the rack in kVA.

                  • RackWeightLbs (float) --

                    The weight of the rack in pounds.

                  • RackHeightInches (float) --

                    The height of the rack in inches.

                  • RackWidthInches (float) --

                    The width of the rack in inches.

                  • RackDepthInches (float) --

                    The depth of the rack in inches.

                  • RackUnitHeight (string) --

                    The rack unit height.

                    • HEIGHT_42U - 42 rack units.

                    • HEIGHT_2U - 2 rack units.

                    • HEIGHT_1U - 1 rack unit.

                  • EC2Capacities (list) --

                    The Amazon EC2 capacities for the rack.

                    • (dict) --

                      Information about EC2 capacity.

                      • Family (string) --

                        The family of the EC2 capacity.

                      • MaxSize (string) --

                        The maximum size of the EC2 capacity.

                      • Quantity (string) --

                        The quantity of the EC2 capacity.

                • ServerSpecificationDetails (dict) --

                  The server specification details, if the specification type is SERVER.

                  • ServerPowerDrawKva (float) --

                    The maximum power draw of the server in kVA.

                  • ServerWeightLbs (float) --

                    The weight of the server in pounds.

                  • ServerHeightInches (float) --

                    The height of the server in inches.

                  • ServerWidthInches (float) --

                    The width of the server in inches.

                  • ServerDepthInches (float) --

                    The depth of the server in inches.

                  • RackUnitHeight (string) --

                    The rack unit height of the server.

                    • HEIGHT_2U - 2 rack units.

                    • HEIGHT_1U - 1 rack unit.

                  • EC2Capacities (list) --

                    The Amazon EC2 capacities for the server.

                    • (dict) --

                      Information about EC2 capacity.

                      • Family (string) --

                        The family of the EC2 capacity.

                      • MaxSize (string) --

                        The maximum size of the EC2 capacity.

                      • Quantity (string) --

                        The quantity of the EC2 capacity.

            • PricingOptions (list) --

              The pricing options for this quote option.

              • (dict) --

                A pricing option for the specified Outpost.

                • PricingType (string) --

                  The type of pricing model.

                • SubscriptionPricingDetails (dict) --

                  The subscription pricing details for this pricing option.

                  • PaymentOption (string) --

                    The payment option.

                  • PaymentTerm (string) --

                    The payment term.

                  • UpfrontPrice (float) --

                    The upfront price.

                  • MonthlyRecurringPrice (float) --

                    The monthly recurring price.

                  • Currency (string) --

                    The currency of the price. Currently only USD is supported.

        • SubmittedOrderId (string) --

          The ID of the order submitted for the quote.

        • CreatedDate (datetime) --

          The date the quote was created.

        • ExpirationDate (datetime) --

          The date the quote expires.

        • Description (string) --

          The description of the quote.

    • NextToken (string) --

      The pagination token.

UpdateOutpost (updated) Link ¶
Changes (response)
{'Outpost': {'Generation': 'GENERATION_2 | GENERATION_1',
             'RackScalingType': 'SINGLE_RACK | MULTI_RACK'}}

Updates an Outpost.

See also: AWS API Documentation

Request Syntax

client.update_outpost(
    OutpostId='string',
    Name='string',
    Description='string',
    SupportedHardwareType='RACK'|'SERVER'
)
type OutpostId:

string

param OutpostId:

[REQUIRED]

The ID or ARN of the Outpost.

type Name:

string

param Name:

The name of the Outpost.

type Description:

string

param Description:

The description of the Outpost.

type SupportedHardwareType:

string

param SupportedHardwareType:

The type of hardware for this Outpost.

rtype:

dict

returns:

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'SupportedHardwareType': 'RACK'|'SERVER',
        'Generation': 'GENERATION_2'|'GENERATION_1',
        'RackScalingType': 'SINGLE_RACK'|'MULTI_RACK'
    }
}

Response Structure

  • (dict) --

    • Outpost (dict) --

      Information about an Outpost.

      • OutpostId (string) --

        The ID of the Outpost.

      • OwnerId (string) --

        The Amazon Web Services account ID of the Outpost owner.

      • OutpostArn (string) --

        The Amazon Resource Name (ARN) of the Outpost.

      • SiteId (string) --

        The ID of the site.

      • Name (string) --

        The name of the Outpost.

      • Description (string) --

        The description of the Outpost.

      • LifeCycleStatus (string) --

        The life cycle status.

      • AvailabilityZone (string) --

        The Availability Zone.

      • AvailabilityZoneId (string) --

        The ID of the Availability Zone.

      • Tags (dict) --

        The Outpost tags.

        • (string) --

          • (string) --

      • SiteArn (string) --

        The Amazon Resource Name (ARN) of the site.

      • SupportedHardwareType (string) --

        The hardware type.

      • Generation (string) --

        The Outpost generation. Valid values are GENERATION_1 for first-generation rack deployments and GENERATION_2 for second-generation rack deployments.

      • RackScalingType (string) --

        The rack scaling type. Valid values are SINGLE_RACK for single-rack Outposts and MULTI_RACK for multi-rack Outposts that can expand across multiple racks.

UpdateQuote (updated) Link ¶
Changes (request, response)
Request
{'RequestedConstraints': {'QuoteConstraintType': {'RACK_SPACE_CONSTRAINED'}}}
Response
{'Quote': {'RequestedConstraints': {'QuoteConstraintType': {'RACK_SPACE_CONSTRAINED'}}}}

Updates the specified quote. You can modify the requested capacities, constraints, payment options, payment terms, or Outpost association.

See also: AWS API Documentation

Request Syntax

client.update_quote(
    QuoteIdentifier='string',
    OutpostIdentifier='string',
    CountryCode='string',
    RequestedCapacities=[
        {
            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
            'Unit': 'string',
            'Quantity': ...
        },
    ],
    RequestedConstraints=[
        {
            'QuoteConstraintType': 'RACK_MAXIMUM'|'RACK_MAX_POWER_KVA'|'RACK_MAX_WEIGHT_LBS'|'RACK_SPACE_CONSTRAINED',
            'Value': 'string'
        },
    ],
    RequestedPaymentOptions=[
        'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
    ],
    RequestedPaymentTerms=[
        'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
    ],
    Description='string'
)
type QuoteIdentifier:

string

param QuoteIdentifier:

[REQUIRED]

The ID of the quote.

type OutpostIdentifier:

string

param OutpostIdentifier:

The ID or ARN of the Outpost to associate with the quote. Specify an empty string to remove the Outpost association.

type CountryCode:

string

param CountryCode:

The country code for the Outpost site location.

type RequestedCapacities:

list

param RequestedCapacities:

The updated capacity requirements for the quote.

  • (dict) --

    A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

    • QuoteCapacityType (string) --

      The type of capacity. Valid values are EC2, EBS, and S3.

    • Unit (string) --

      The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

    • Quantity (float) --

      The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

type RequestedConstraints:

list

param RequestedConstraints:

The updated physical constraints for the quote.

  • (dict) --

    A physical constraint for a quote.

    • QuoteConstraintType (string) --

      The type of constraint. Valid values are RACK_MAXIMUM, RACK_MAX_POWER_KVA, RACK_MAX_WEIGHT_LBS, and RACK_SPACE_CONSTRAINED.

    • Value (string) --

      The value of the constraint.

type RequestedPaymentOptions:

list

param RequestedPaymentOptions:

The updated payment options to include in the quote pricing.

  • (string) --

type RequestedPaymentTerms:

list

param RequestedPaymentTerms:

The updated payment terms to include in the quote pricing.

  • (string) --

type Description:

string

param Description:

A description for the quote.

rtype:

dict

returns:

Response Syntax

{
    'Quote': {
        'QuoteId': 'string',
        'AccountId': 'string',
        'QuoteStatus': 'CREATED'|'ORDER_SUBMITTED'|'EXPIRED',
        'StatusMessage': 'string',
        'OutpostArn': 'string',
        'CountryCode': 'string',
        'RequestedCapacities': [
            {
                'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                'Unit': 'string',
                'Quantity': ...
            },
        ],
        'RequestedConstraints': [
            {
                'QuoteConstraintType': 'RACK_MAXIMUM'|'RACK_MAX_POWER_KVA'|'RACK_MAX_WEIGHT_LBS'|'RACK_SPACE_CONSTRAINED',
                'Value': 'string'
            },
        ],
        'RequestedPaymentOptions': [
            'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
        ],
        'RequestedPaymentTerms': [
            'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
        ],
        'QuoteOptions': [
            {
                'QuoteOptionIdentifier': 'string',
                'Capacities': [
                    {
                        'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                        'Unit': 'string',
                        'Quantity': ...
                    },
                ],
                'CapacitySummary': {
                    'ExistingCapacities': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ],
                    'FinalCapacities': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ],
                    'CapacityChange': [
                        {
                            'QuoteCapacityType': 'EC2'|'EBS'|'S3',
                            'Unit': 'string',
                            'Quantity': ...
                        },
                    ]
                },
                'Specifications': [
                    {
                        'QuoteSpecificationType': 'UPDATED_RACK'|'NEW_RACK'|'EXISTING_RACK'|'SERVER',
                        'ExistingRackSpecificationDetails': {
                            'RackId': 'string',
                            'RackUse': 'NETWORKING'|'COMPUTE',
                            'RackPowerDrawKva': ...,
                            'RackWeightLbs': ...,
                            'RackHeightInches': ...,
                            'RackWidthInches': ...,
                            'RackDepthInches': ...,
                            'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                            'EC2Capacities': [
                                {
                                    'Family': 'string',
                                    'MaxSize': 'string',
                                    'Quantity': 'string'
                                },
                            ]
                        },
                        'FinalRackSpecificationDetails': {
                            'RackId': 'string',
                            'RackUse': 'NETWORKING'|'COMPUTE',
                            'RackPowerDrawKva': ...,
                            'RackWeightLbs': ...,
                            'RackHeightInches': ...,
                            'RackWidthInches': ...,
                            'RackDepthInches': ...,
                            'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                            'EC2Capacities': [
                                {
                                    'Family': 'string',
                                    'MaxSize': 'string',
                                    'Quantity': 'string'
                                },
                            ]
                        },
                        'ServerSpecificationDetails': {
                            'ServerPowerDrawKva': ...,
                            'ServerWeightLbs': ...,
                            'ServerHeightInches': ...,
                            'ServerWidthInches': ...,
                            'ServerDepthInches': ...,
                            'RackUnitHeight': 'HEIGHT_42U'|'HEIGHT_2U'|'HEIGHT_1U',
                            'EC2Capacities': [
                                {
                                    'Family': 'string',
                                    'MaxSize': 'string',
                                    'Quantity': 'string'
                                },
                            ]
                        }
                    },
                ],
                'PricingOptions': [
                    {
                        'PricingType': 'SUBSCRIPTION',
                        'SubscriptionPricingDetails': {
                            'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
                            'PaymentTerm': 'THREE_YEARS'|'ONE_YEAR'|'FIVE_YEARS',
                            'UpfrontPrice': ...,
                            'MonthlyRecurringPrice': ...,
                            'Currency': 'USD'
                        }
                    },
                ]
            },
        ],
        'OrderingRequirements': [
            {
                'StatusMessage': 'string',
                'OrderingRequirementType': 'OUTPOST_ACTIVE_CHECK_ERROR'|'MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR'|'VALID_ZIP_CODE_CHECK_ERROR'|'RACK_PHYSICAL_PROPERTIES_CHECK_ERROR'|'OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR'|'SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR'|'COUNTRY_CODE_MISMATCH_CHECK_ERROR'|'OUTPOST_GENERATION_MISMATCH_ERROR'|'UNSUPPORTED'|'OUTPOST_ID_MISSING_ON_QUOTE_ERROR'|'ENTERPRISE_SUPPORT_ERROR'|'SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR'|'SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR'|'SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR'|'OUTPOST_STATE_CHANGED_ERROR'|'OUTPOST_NOT_FOUND_ERROR'|'OUTPOST_RENEWAL_REQUIRED_ERROR',
                'Status': 'PASS'|'FAIL'|'EXEMPT'
            },
        ],
        'SubmittedOrderId': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'ExpirationDate': datetime(2015, 1, 1),
        'Description': 'string'
    }
}

Response Structure

  • (dict) --

    • Quote (dict) --

      Information about the updated quote.

      • QuoteId (string) --

        The ID of the quote.

      • AccountId (string) --

        The ID of the account that owns the quote.

      • QuoteStatus (string) --

        The status of the quote.

        • CREATED - The quote has been created and is available for review.

        • ORDER_SUBMITTED - An order has been submitted for the quote.

        • EXPIRED - The quote has expired and can no longer be used to submit an order.

      • StatusMessage (string) --

        A message about the status of the quote.

      • OutpostArn (string) --

        The ARN of the Outpost associated with the quote.

      • CountryCode (string) --

        The country code for the Outpost site location.

      • RequestedCapacities (list) --

        The capacity requirements specified in the quote request.

        • (dict) --

          A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

          • QuoteCapacityType (string) --

            The type of capacity. Valid values are EC2, EBS, and S3.

          • Unit (string) --

            The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

          • Quantity (float) --

            The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

      • RequestedConstraints (list) --

        The physical constraints specified in the quote request.

        • (dict) --

          A physical constraint for a quote.

          • QuoteConstraintType (string) --

            The type of constraint. Valid values are RACK_MAXIMUM, RACK_MAX_POWER_KVA, RACK_MAX_WEIGHT_LBS, and RACK_SPACE_CONSTRAINED.

          • Value (string) --

            The value of the constraint.

      • RequestedPaymentOptions (list) --

        The payment options specified in the quote request.

        • (string) --

      • RequestedPaymentTerms (list) --

        The payment terms specified in the quote request.

        • (string) --

      • QuoteOptions (list) --

        The configuration and pricing options for the quote. Each option includes capacity details, physical specifications, and pricing information.

        • (dict) --

          A configuration and pricing option for a quote. Each option includes the capacity breakdown, physical specifications for the racks or servers, and pricing details.

          • QuoteOptionIdentifier (string) --

            The ID of the quote option.

          • Capacities (list) --

            The capacities included in this quote option.

            • (dict) --

              A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

              • QuoteCapacityType (string) --

                The type of capacity. Valid values are EC2, EBS, and S3.

              • Unit (string) --

                The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

              • Quantity (float) --

                The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

          • CapacitySummary (dict) --

            A summary of the existing, final, and changed capacity for this quote option.

            • ExistingCapacities (list) --

              The existing capacities on the Outpost before the quote is fulfilled.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

            • FinalCapacities (list) --

              The final capacities on the Outpost after the quote is fulfilled.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

            • CapacityChange (list) --

              The change in capacity between the existing and final state.

              • (dict) --

                A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

                • QuoteCapacityType (string) --

                  The type of capacity. Valid values are EC2, EBS, and S3.

                • Unit (string) --

                  The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

                • Quantity (float) --

                  The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

          • Specifications (list) --

            The physical specifications for the racks or servers in this quote option.

            • (dict) --

              A physical specification for a quote option. Describes the rack or server configuration that would be deployed.

              • QuoteSpecificationType (string) --

                The type of specification. Valid values are NEW_RACK, UPDATED_RACK, EXISTING_RACK, and SERVER.

              • ExistingRackSpecificationDetails (dict) --

                The existing rack specification details, if the specification type is UPDATED_RACK or EXISTING_RACK.

                • RackId (string) --

                  The ID of the rack.

                • RackUse (string) --

                  The use of the rack. Valid values are COMPUTE and NETWORKING.

                • RackPowerDrawKva (float) --

                  The maximum power draw of the rack in kVA.

                • RackWeightLbs (float) --

                  The weight of the rack in pounds.

                • RackHeightInches (float) --

                  The height of the rack in inches.

                • RackWidthInches (float) --

                  The width of the rack in inches.

                • RackDepthInches (float) --

                  The depth of the rack in inches.

                • RackUnitHeight (string) --

                  The rack unit height.

                  • HEIGHT_42U - 42 rack units.

                  • HEIGHT_2U - 2 rack units.

                  • HEIGHT_1U - 1 rack unit.

                • EC2Capacities (list) --

                  The Amazon EC2 capacities for the rack.

                  • (dict) --

                    Information about EC2 capacity.

                    • Family (string) --

                      The family of the EC2 capacity.

                    • MaxSize (string) --

                      The maximum size of the EC2 capacity.

                    • Quantity (string) --

                      The quantity of the EC2 capacity.

              • FinalRackSpecificationDetails (dict) --

                The final rack specification details after the quote is fulfilled.

                • RackId (string) --

                  The ID of the rack.

                • RackUse (string) --

                  The use of the rack. Valid values are COMPUTE and NETWORKING.

                • RackPowerDrawKva (float) --

                  The maximum power draw of the rack in kVA.

                • RackWeightLbs (float) --

                  The weight of the rack in pounds.

                • RackHeightInches (float) --

                  The height of the rack in inches.

                • RackWidthInches (float) --

                  The width of the rack in inches.

                • RackDepthInches (float) --

                  The depth of the rack in inches.

                • RackUnitHeight (string) --

                  The rack unit height.

                  • HEIGHT_42U - 42 rack units.

                  • HEIGHT_2U - 2 rack units.

                  • HEIGHT_1U - 1 rack unit.

                • EC2Capacities (list) --

                  The Amazon EC2 capacities for the rack.

                  • (dict) --

                    Information about EC2 capacity.

                    • Family (string) --

                      The family of the EC2 capacity.

                    • MaxSize (string) --

                      The maximum size of the EC2 capacity.

                    • Quantity (string) --

                      The quantity of the EC2 capacity.

              • ServerSpecificationDetails (dict) --

                The server specification details, if the specification type is SERVER.

                • ServerPowerDrawKva (float) --

                  The maximum power draw of the server in kVA.

                • ServerWeightLbs (float) --

                  The weight of the server in pounds.

                • ServerHeightInches (float) --

                  The height of the server in inches.

                • ServerWidthInches (float) --

                  The width of the server in inches.

                • ServerDepthInches (float) --

                  The depth of the server in inches.

                • RackUnitHeight (string) --

                  The rack unit height of the server.

                  • HEIGHT_2U - 2 rack units.

                  • HEIGHT_1U - 1 rack unit.

                • EC2Capacities (list) --

                  The Amazon EC2 capacities for the server.

                  • (dict) --

                    Information about EC2 capacity.

                    • Family (string) --

                      The family of the EC2 capacity.

                    • MaxSize (string) --

                      The maximum size of the EC2 capacity.

                    • Quantity (string) --

                      The quantity of the EC2 capacity.

          • PricingOptions (list) --

            The pricing options for this quote option.

            • (dict) --

              A pricing option for the specified Outpost.

              • PricingType (string) --

                The type of pricing model.

              • SubscriptionPricingDetails (dict) --

                The subscription pricing details for this pricing option.

                • PaymentOption (string) --

                  The payment option.

                • PaymentTerm (string) --

                  The payment term.

                • UpfrontPrice (float) --

                  The upfront price.

                • MonthlyRecurringPrice (float) --

                  The monthly recurring price.

                • Currency (string) --

                  The currency of the price. Currently only USD is supported.

      • OrderingRequirements (list) --

        The requirements that must be met before an order can be submitted for the quote.

        • (dict) --

          A requirement that must be met before an order can be submitted for a quote.

          • StatusMessage (string) --

            A message about the ordering requirement.

          • OrderingRequirementType (string) --

            The type of ordering requirement. Indicates which check failed or passed.

            • OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state.

            • MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached.

            • VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code.

            • RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements.

            • OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address.

            • SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address.

            • COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country.

            • OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration.

            • OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order.

            • ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required.

            • SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name.

            • SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number.

            • SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information.

            • OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created.

            • OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found.

            • OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted.

            • UNSUPPORTED - The requirement type is not recognized.

          • Status (string) --

            The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT.

      • SubmittedOrderId (string) --

        The ID of the order submitted for the quote.

      • CreatedDate (datetime) --

        The date the quote was created.

      • ExpirationDate (datetime) --

        The date the quote expires.

      • Description (string) --

        The description of the quote.