openapi: 3.0.0 info: version: 2019-12-03 x-release: v4 title: AWS Outposts Catalog Sites API description: Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local data processing needs. x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: outposts x-aws-signingName: outposts x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/outposts-2019-12-03.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://outposts.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Outposts multi-region endpoint - url: https://outposts.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Outposts multi-region endpoint - url: http://outposts.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Outposts endpoint for China (Beijing) and China (Ningxia) - url: https://outposts.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Outposts endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Sites paths: /sites: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateSite description: ' Creates a site for an Outpost. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSiteOutput' examples: CreateSite200Example: summary: Default CreateSite 200 response x-microcks-default: true value: Site: example-ref '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '484': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Name properties: Name: description: The name of the site. type: string pattern: ^[\S ]+$ minLength: 1 maxLength: 1000 Description: description: The description of the site. type: string pattern: ^[\S ]+$ minLength: 1 maxLength: 1001 Notes: description: 'Additional information that you provide about site access requirements, electrician scheduling, personal protective equipment, or regulation of equipment materials that could affect your installation process. ' type: string pattern: ^[\S \n]+$ minLength: 1 maxLength: 2000 Tags: description: ' The tags to apply to a site. ' type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' OperatingAddress: description: ' Information about an address. ' type: object properties: ContactName: allOf: - $ref: '#/components/schemas/ContactName' - description: The name of the contact. ContactPhoneNumber: allOf: - $ref: '#/components/schemas/ContactPhoneNumber' - description: The phone number of the contact. AddressLine1: allOf: - $ref: '#/components/schemas/AddressLine1' - description: The first line of the address. AddressLine2: allOf: - $ref: '#/components/schemas/AddressLine2' - description: The second line of the address. AddressLine3: allOf: - $ref: '#/components/schemas/AddressLine3' - description: The third line of the address. City: allOf: - $ref: '#/components/schemas/City' - description: The city for the address. StateOrRegion: allOf: - $ref: '#/components/schemas/StateOrRegion' - description: The state for the address. DistrictOrCounty: allOf: - $ref: '#/components/schemas/DistrictOrCounty' - description: The district or county for the address. PostalCode: allOf: - $ref: '#/components/schemas/PostalCode' - description: The postal code for the address. CountryCode: allOf: - $ref: '#/components/schemas/CountryCode' - description: The ISO-3166 two-letter country code for the address. Municipality: allOf: - $ref: '#/components/schemas/Municipality' - description: The municipality for the address. ShippingAddress: description: ' Information about an address. ' type: object properties: ContactName: allOf: - $ref: '#/components/schemas/ContactName' - description: The name of the contact. ContactPhoneNumber: allOf: - $ref: '#/components/schemas/ContactPhoneNumber' - description: The phone number of the contact. AddressLine1: allOf: - $ref: '#/components/schemas/AddressLine1' - description: The first line of the address. AddressLine2: allOf: - $ref: '#/components/schemas/AddressLine2' - description: The second line of the address. AddressLine3: allOf: - $ref: '#/components/schemas/AddressLine3' - description: The third line of the address. City: allOf: - $ref: '#/components/schemas/City' - description: The city for the address. StateOrRegion: allOf: - $ref: '#/components/schemas/StateOrRegion' - description: The state for the address. DistrictOrCounty: allOf: - $ref: '#/components/schemas/DistrictOrCounty' - description: The district or county for the address. PostalCode: allOf: - $ref: '#/components/schemas/PostalCode' - description: The postal code for the address. CountryCode: allOf: - $ref: '#/components/schemas/CountryCode' - description: The ISO-3166 two-letter country code for the address. Municipality: allOf: - $ref: '#/components/schemas/Municipality' - description: The municipality for the address. RackPhysicalProperties: description: ' Information about the physical and logistical details for racks at sites. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide. ' type: object properties: PowerDrawKva: allOf: - $ref: '#/components/schemas/PowerDrawKva' - description: 'The power draw available at the hardware placement position for the rack. ' PowerPhase: allOf: - $ref: '#/components/schemas/PowerPhase' - description: The power option that you can provide for hardware. PowerConnector: allOf: - $ref: '#/components/schemas/PowerConnector' - description: 'The power connector for the hardware. ' PowerFeedDrop: allOf: - $ref: '#/components/schemas/PowerFeedDrop' - description: The position of the power feed. UplinkGbps: allOf: - $ref: '#/components/schemas/UplinkGbps' - description: 'The uplink speed the rack supports for the connection to the Region. ' UplinkCount: allOf: - $ref: '#/components/schemas/UplinkCount' - description: The number of uplinks each Outpost network device. FiberOpticCableType: allOf: - $ref: '#/components/schemas/FiberOpticCableType' - description: 'The type of fiber used to attach the Outpost to the network. ' OpticalStandard: allOf: - $ref: '#/components/schemas/OpticalStandard' - description: 'The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide. ' MaximumSupportedWeightLbs: allOf: - $ref: '#/components/schemas/MaximumSupportedWeightLbs' - description: 'The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg). ' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Outposts Create Site tags: - Sites get: operationId: ListSites description:

Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSitesOutput' examples: ListSites200Example: summary: Default ListSites 200 response x-microcks-default: true value: Sites: example-ref NextToken: example-ref '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: NextToken in: query required: false description: '' schema: type: string pattern: ^(\d+)##(\S+)$ description: The pagination token. minLength: 1 maxLength: 2048 - name: MaxResults in: query required: false description: '' schema: type: integer description: The maximum page size. minimum: 1 maximum: 1000 - name: OperatingAddressCountryCodeFilter in: query required: false description: Filters the results by country code. schema: type: array items: $ref: '#/components/schemas/CountryCode' - name: OperatingAddressStateOrRegionFilter in: query required: false description: Filters the results by state or region. schema: type: array items: $ref: '#/components/schemas/StateOrRegion' - name: OperatingAddressCityFilter in: query required: false description: Filters the results by city. schema: type: array items: $ref: '#/components/schemas/City' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Outposts List Sites tags: - Sites /sites/{SiteId}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteSite description: Deletes the specified site. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSiteOutput' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: SiteId in: path required: true description: ' The ID or the Amazon Resource Name (ARN) of the site. ' schema: type: string pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$ description: The ID of the site. minLength: 1 maxLength: 255 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Outposts Delete Site tags: - Sites get: operationId: GetSite description: Gets information about the specified Outpost site. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSiteOutput' examples: GetSite200Example: summary: Default GetSite 200 response x-microcks-default: true value: Site: example-ref '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: SiteId in: path required: true description: ' The ID or the Amazon Resource Name (ARN) of the site. ' schema: type: string pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$ description: The ID of the site. minLength: 1 maxLength: 255 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Outposts Get Site tags: - Sites patch: operationId: UpdateSite description: Updates the specified site. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSiteOutput' examples: UpdateSite200Example: summary: Default UpdateSite 200 response x-microcks-default: true value: Site: example-ref '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: SiteId in: path required: true description: ' The ID or the Amazon Resource Name (ARN) of the site. ' schema: type: string pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$ description: The ID of the site. minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: Name: description: The name of the site. type: string pattern: ^[\S ]+$ minLength: 1 maxLength: 1000 Description: description: The description of the site. type: string pattern: ^[\S ]+$ minLength: 1 maxLength: 1001 Notes: description: Notes about a site. type: string pattern: ^[\S \n]+$ minLength: 1 maxLength: 2000 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Outposts Update Site tags: - Sites /sites/{SiteId}/address#AddressType: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSiteAddress description: ' Gets the site address of the specified site. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSiteAddressOutput' examples: GetSiteAddress200Example: summary: Default GetSiteAddress 200 response x-microcks-default: true value: SiteId: example-ref AddressType: standard Address: example-string '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: SiteId in: path required: true description: ' The ID or the Amazon Resource Name (ARN) of the site. ' schema: type: string pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$ description: The ID of the site. minLength: 1 maxLength: 255 - name: AddressType in: query required: true description: 'The type of the address you request. ' schema: type: string enum: - SHIPPING_ADDRESS - OPERATING_ADDRESS x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Outposts Get Site Address tags: - Sites /sites/{SiteId}/address: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateSiteAddress description:

Updates the address of the specified site.

You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order.

You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSiteAddressOutput' examples: UpdateSiteAddress200Example: summary: Default UpdateSiteAddress 200 response x-microcks-default: true value: AddressType: standard Address: example-string '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: SiteId in: path required: true description: ' The ID or the Amazon Resource Name (ARN) of the site. ' schema: type: string pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$ description: The ID of the site. minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - AddressType - Address properties: AddressType: description: ' The type of the address. ' type: string enum: - SHIPPING_ADDRESS - OPERATING_ADDRESS Address: description: ' Information about an address. ' type: object properties: ContactName: allOf: - $ref: '#/components/schemas/ContactName' - description: The name of the contact. ContactPhoneNumber: allOf: - $ref: '#/components/schemas/ContactPhoneNumber' - description: The phone number of the contact. AddressLine1: allOf: - $ref: '#/components/schemas/AddressLine1' - description: The first line of the address. AddressLine2: allOf: - $ref: '#/components/schemas/AddressLine2' - description: The second line of the address. AddressLine3: allOf: - $ref: '#/components/schemas/AddressLine3' - description: The third line of the address. City: allOf: - $ref: '#/components/schemas/City' - description: The city for the address. StateOrRegion: allOf: - $ref: '#/components/schemas/StateOrRegion' - description: The state for the address. DistrictOrCounty: allOf: - $ref: '#/components/schemas/DistrictOrCounty' - description: The district or county for the address. PostalCode: allOf: - $ref: '#/components/schemas/PostalCode' - description: The postal code for the address. CountryCode: allOf: - $ref: '#/components/schemas/CountryCode' - description: The ISO-3166 two-letter country code for the address. Municipality: allOf: - $ref: '#/components/schemas/Municipality' - description: The municipality for the address. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Outposts Update Site Address tags: - Sites /sites/{SiteId}/rackPhysicalProperties: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' patch: operationId: UpdateSiteRackPhysicalProperties description:

Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSiteRackPhysicalPropertiesOutput' examples: UpdateSiteRackPhysicalProperties200Example: summary: Default UpdateSiteRackPhysicalProperties 200 response x-microcks-default: true value: Site: example-ref '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: SiteId in: path required: true description: ' The ID or the Amazon Resource Name (ARN) of the site. ' schema: type: string pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$ description: The ID of the site. minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: PowerDrawKva: description: The power draw, in kVA, available at the hardware placement position for the rack. type: string enum: - POWER_5_KVA - POWER_10_KVA - POWER_15_KVA - POWER_30_KVA PowerPhase: description: '

The power option that you can provide for hardware.

' type: string enum: - SINGLE_PHASE - THREE_PHASE PowerConnector: description:

The power connector that Amazon Web Services should plan to provide for connections to the hardware. Note the correlation between PowerPhase and PowerConnector.

type: string enum: - L6_30P - IEC309 - AH530P7W - AH532P6W PowerFeedDrop: description: 'Indicates whether the power feed comes above or below the rack. ' type: string enum: - ABOVE_RACK - BELOW_RACK UplinkGbps: description: 'The uplink speed the rack should support for the connection to the Region. ' type: string enum: - UPLINK_1G - UPLINK_10G - UPLINK_40G - UPLINK_100G UplinkCount: description: '

Racks come with two Outpost network devices. Depending on the supported uplink speed at the site, the Outpost network devices provide a variable number of uplinks. Specify the number of uplinks for each Outpost network device that you intend to use to connect the rack to your network. Note the correlation between UplinkGbps and UplinkCount.

' type: string enum: - UPLINK_COUNT_1 - UPLINK_COUNT_2 - UPLINK_COUNT_3 - UPLINK_COUNT_4 - UPLINK_COUNT_5 - UPLINK_COUNT_6 - UPLINK_COUNT_7 - UPLINK_COUNT_8 - UPLINK_COUNT_12 - UPLINK_COUNT_16 FiberOpticCableType: description: 'The type of fiber that you will use to attach the Outpost to your network. ' type: string enum: - SINGLE_MODE - MULTI_MODE OpticalStandard: description: '

The type of optical standard that you will use to attach the Outpost to your network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.

' type: string enum: - OPTIC_10GBASE_SR - OPTIC_10GBASE_IR - OPTIC_10GBASE_LR - OPTIC_40GBASE_SR - OPTIC_40GBASE_ESR - OPTIC_40GBASE_IR4_LR4L - OPTIC_40GBASE_LR4 - OPTIC_100GBASE_SR4 - OPTIC_100GBASE_CWDM4 - OPTIC_100GBASE_LR4 - OPTIC_100G_PSM4_MSA - OPTIC_1000BASE_LX - OPTIC_1000BASE_SX MaximumSupportedWeightLbs: description: 'The maximum rack weight that this site can support. NO_LIMIT is over 2000lbs. ' type: string enum: - NO_LIMIT - MAX_1400_LBS - MAX_1600_LBS - MAX_1800_LBS - MAX_2000_LBS x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Outposts Update Site Rack Physical Properties tags: - Sites components: parameters: X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false schemas: SiteName: type: string pattern: ^[\S ]+$ description: The name of the site. minLength: 1 maxLength: 1000 NotFoundException: {} CountryCode: type: string pattern: ^[A-Z]{2}$ minLength: 2 maxLength: 2 PowerPhase: type: string enum: - SINGLE_PHASE - THREE_PHASE AccessDeniedException: {} FiberOpticCableType: type: string enum: - SINGLE_MODE - MULTI_MODE PowerConnector: type: string enum: - L6_30P - IEC309 - AH530P7W - AH532P6W GetSiteOutput: type: object properties: Site: $ref: '#/components/schemas/Site' SiteId: type: string pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$ description: The ID of the site. minLength: 1 maxLength: 255 GetSiteAddressOutput: type: object properties: SiteId: $ref: '#/components/schemas/SiteId' AddressType: allOf: - $ref: '#/components/schemas/AddressType' - description: 'The type of the address you receive. ' Address: allOf: - $ref: '#/components/schemas/Address' - description: ' Information about the address. ' AccountId: type: string pattern: \d{12} description: The ID of the Amazon Web Services account. minLength: 12 maxLength: 12 ConflictException: {} AddressLine1: type: string pattern: ^\S[\S ]*$ minLength: 1 maxLength: 180 SiteDescription: type: string pattern: ^[\S ]+$ description: The description of the site. minLength: 1 maxLength: 1001 CreateSiteOutput: type: object properties: Site: $ref: '#/components/schemas/Site' SiteNotes: type: string pattern: ^[\S \n]+$ minLength: 1 maxLength: 2000 City: type: string pattern: ^\S[\S ]*$ minLength: 1 maxLength: 50 TagMap: type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' AddressLine3: type: string pattern: ^\S[\S ]*$ minLength: 0 maxLength: 60 Site: type: object properties: SiteId: $ref: '#/components/schemas/SiteId' AccountId: $ref: '#/components/schemas/AccountId' Name: $ref: '#/components/schemas/SiteName' Description: $ref: '#/components/schemas/SiteDescription' Tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The site tags. SiteArn: $ref: '#/components/schemas/SiteArn' Notes: allOf: - $ref: '#/components/schemas/SiteNotes' - description: ' Notes about a site. ' OperatingAddressCountryCode: allOf: - $ref: '#/components/schemas/CountryCode' - description: ' The ISO-3166 two-letter country code where the hardware is installed and powered on. ' OperatingAddressStateOrRegion: allOf: - $ref: '#/components/schemas/StateOrRegion' - description: ' State or region where the hardware is installed and powered on. ' OperatingAddressCity: allOf: - $ref: '#/components/schemas/City' - description: ' City where the hardware is installed and powered on. ' RackPhysicalProperties: allOf: - $ref: '#/components/schemas/RackPhysicalProperties' - description: ' Information about the physical and logistical details for a rack at the site. ' description: Information about a site. UplinkCount: type: string enum: - UPLINK_COUNT_1 - UPLINK_COUNT_2 - UPLINK_COUNT_3 - UPLINK_COUNT_4 - UPLINK_COUNT_5 - UPLINK_COUNT_6 - UPLINK_COUNT_7 - UPLINK_COUNT_8 - UPLINK_COUNT_12 - UPLINK_COUNT_16 UpdateSiteOutput: type: object properties: Site: $ref: '#/components/schemas/Site' DistrictOrCounty: type: string pattern: ^\S[\S ]* minLength: 1 maxLength: 60 ServiceQuotaExceededException: {} UpdateSiteAddressOutput: type: object properties: AddressType: allOf: - $ref: '#/components/schemas/AddressType' - description: ' The type of the address. ' Address: allOf: - $ref: '#/components/schemas/Address' - description: ' Information about an address. ' PowerFeedDrop: type: string enum: - ABOVE_RACK - BELOW_RACK InternalServerException: {} Token: type: string pattern: ^(\d+)##(\S+)$ description: The pagination token. minLength: 1 maxLength: 2048 OpticalStandard: type: string enum: - OPTIC_10GBASE_SR - OPTIC_10GBASE_IR - OPTIC_10GBASE_LR - OPTIC_40GBASE_SR - OPTIC_40GBASE_ESR - OPTIC_40GBASE_IR4_LR4L - OPTIC_40GBASE_LR4 - OPTIC_100GBASE_SR4 - OPTIC_100GBASE_CWDM4 - OPTIC_100GBASE_LR4 - OPTIC_100G_PSM4_MSA - OPTIC_1000BASE_LX - OPTIC_1000BASE_SX UpdateSiteRackPhysicalPropertiesOutput: type: object properties: Site: $ref: '#/components/schemas/Site' siteListDefinition: type: array description: Information about the sites. items: $ref: '#/components/schemas/Site' RackPhysicalProperties: type: object properties: PowerDrawKva: allOf: - $ref: '#/components/schemas/PowerDrawKva' - description: 'The power draw available at the hardware placement position for the rack. ' PowerPhase: allOf: - $ref: '#/components/schemas/PowerPhase' - description: The power option that you can provide for hardware. PowerConnector: allOf: - $ref: '#/components/schemas/PowerConnector' - description: 'The power connector for the hardware. ' PowerFeedDrop: allOf: - $ref: '#/components/schemas/PowerFeedDrop' - description: The position of the power feed. UplinkGbps: allOf: - $ref: '#/components/schemas/UplinkGbps' - description: 'The uplink speed the rack supports for the connection to the Region. ' UplinkCount: allOf: - $ref: '#/components/schemas/UplinkCount' - description: The number of uplinks each Outpost network device. FiberOpticCableType: allOf: - $ref: '#/components/schemas/FiberOpticCableType' - description: 'The type of fiber used to attach the Outpost to the network. ' OpticalStandard: allOf: - $ref: '#/components/schemas/OpticalStandard' - description: 'The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide. ' MaximumSupportedWeightLbs: allOf: - $ref: '#/components/schemas/MaximumSupportedWeightLbs' - description: 'The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg). ' description: ' Information about the physical and logistical details for racks at sites. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide. ' ContactPhoneNumber: type: string pattern: ^[\S ]+$ minLength: 1 maxLength: 20 AddressType: type: string enum: - SHIPPING_ADDRESS - OPERATING_ADDRESS PostalCode: type: string pattern: ^[a-zA-Z0-9 -]+$ minLength: 1 maxLength: 20 PowerDrawKva: type: string enum: - POWER_5_KVA - POWER_10_KVA - POWER_15_KVA - POWER_30_KVA ContactName: type: string pattern: ^\S[\S ]*$ minLength: 1 maxLength: 255 MaximumSupportedWeightLbs: type: string enum: - NO_LIMIT - MAX_1400_LBS - MAX_1600_LBS - MAX_1800_LBS - MAX_2000_LBS Address: type: object required: - AddressLine1 - City - StateOrRegion - PostalCode - CountryCode properties: ContactName: allOf: - $ref: '#/components/schemas/ContactName' - description: The name of the contact. ContactPhoneNumber: allOf: - $ref: '#/components/schemas/ContactPhoneNumber' - description: The phone number of the contact. AddressLine1: allOf: - $ref: '#/components/schemas/AddressLine1' - description: The first line of the address. AddressLine2: allOf: - $ref: '#/components/schemas/AddressLine2' - description: The second line of the address. AddressLine3: allOf: - $ref: '#/components/schemas/AddressLine3' - description: The third line of the address. City: allOf: - $ref: '#/components/schemas/City' - description: The city for the address. StateOrRegion: allOf: - $ref: '#/components/schemas/StateOrRegion' - description: The state for the address. DistrictOrCounty: allOf: - $ref: '#/components/schemas/DistrictOrCounty' - description: The district or county for the address. PostalCode: allOf: - $ref: '#/components/schemas/PostalCode' - description: The postal code for the address. CountryCode: allOf: - $ref: '#/components/schemas/CountryCode' - description: The ISO-3166 two-letter country code for the address. Municipality: allOf: - $ref: '#/components/schemas/Municipality' - description: The municipality for the address. description: ' Information about an address. ' DeleteSiteOutput: type: object properties: {} ValidationException: {} AddressLine2: type: string pattern: ^\S[\S ]*$ minLength: 0 maxLength: 60 SiteArn: type: string pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/(os-[a-f0-9]{17})$ description: The Amazon Resource Name (ARN) of the site. minLength: 1 maxLength: 255 ListSitesOutput: type: object properties: Sites: $ref: '#/components/schemas/siteListDefinition' NextToken: $ref: '#/components/schemas/Token' UplinkGbps: type: string enum: - UPLINK_1G - UPLINK_10G - UPLINK_40G - UPLINK_100G Municipality: type: string pattern: ^\S[\S ]*$ minLength: 0 maxLength: 180 StateOrRegion: type: string pattern: ^\S[\S ]*$ minLength: 1 maxLength: 50 TagValue: type: string pattern: ^[\S \n]+$ maxLength: 256 securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/outposts/ x-hasEquivalentPaths: true