The Outposts API from Amazon Outposts — 4 operation(s) for outposts.
openapi: 3.0.0
info:
version: 2019-12-03
x-release: v4
title: AWS Catalog Outposts 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: Outposts
paths:
/outposts:
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: CreateOutpost
description: <p>Creates an Outpost.</p> <p>You can specify either an Availability one or an AZ ID.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOutpostOutput'
examples:
CreateOutpost200Example:
summary: Default CreateOutpost 200 response
x-microcks-default: true
value:
Outpost: 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'
'485':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Name
- SiteId
properties:
Name:
description: The name of the Outpost.
type: string
pattern: ^[\S ]+$
minLength: 1
maxLength: 255
Description:
description: The description of the Outpost.
type: string
pattern: ^[\S ]*$
minLength: 0
maxLength: 1000
SiteId:
description: The ID of the site.
type: string
pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$
minLength: 1
maxLength: 255
AvailabilityZone:
description: The Availability Zone.
type: string
pattern: ^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\d+[a-zA-Z]?)?$
minLength: 1
maxLength: 1000
AvailabilityZoneId:
description: The ID of the Availability Zone.
type: string
pattern: ^[a-zA-Z]+\d-[a-zA-Z]+\d$
minLength: 1
maxLength: 255
Tags:
description: The tags to apply to the Outpost.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
SupportedHardwareType:
description: ' The type of hardware for this Outpost. '
type: string
enum:
- RACK
- SERVER
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Create Outpost
tags:
- Outposts
get:
operationId: ListOutposts
description: <p>Lists the Outposts for your Amazon Web Services account.</p> <p>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.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListOutpostsOutput'
examples:
ListOutposts200Example:
summary: Default ListOutposts 200 response
x-microcks-default: true
value:
Outposts: 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: LifeCycleStatusFilter
in: query
required: false
description: Filters the results by the lifecycle status.
schema:
type: array
items:
$ref: '#/components/schemas/LifeCycleStatus'
minItems: 1
maxItems: 5
- name: AvailabilityZoneFilter
in: query
required: false
description: Filters the results by Availability Zone (for example, <code>us-east-1a</code>).
schema:
type: array
items:
$ref: '#/components/schemas/AvailabilityZone'
minItems: 1
maxItems: 5
- name: AvailabilityZoneIdFilter
in: query
required: false
description: Filters the results by AZ ID (for example, <code>use1-az1</code>).
schema:
type: array
items:
$ref: '#/components/schemas/AvailabilityZoneId'
minItems: 1
maxItems: 5
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts List Outposts
tags:
- Outposts
/outposts/{OutpostId}:
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: DeleteOutpost
description: Deletes the specified Outpost.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteOutpostOutput'
'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: OutpostId
in: path
required: true
description: ' The ID or the Amazon Resource Name (ARN) of the Outpost. '
schema:
type: string
pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
minLength: 1
maxLength: 180
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Delete Outpost
tags:
- Outposts
get:
operationId: GetOutpost
description: Gets information about the specified Outpost.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetOutpostOutput'
examples:
GetOutpost200Example:
summary: Default GetOutpost 200 response
x-microcks-default: true
value:
Outpost: 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: OutpostId
in: path
required: true
description: ' The ID or the Amazon Resource Name (ARN) of the Outpost. '
schema:
type: string
pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
minLength: 1
maxLength: 180
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Get Outpost
tags:
- Outposts
patch:
operationId: UpdateOutpost
description: ' Updates an Outpost. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOutpostOutput'
examples:
UpdateOutpost200Example:
summary: Default UpdateOutpost 200 response
x-microcks-default: true
value:
Outpost: 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: OutpostId
in: path
required: true
description: ' The ID or the Amazon Resource Name (ARN) of the Outpost. '
schema:
type: string
pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
minLength: 1
maxLength: 180
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
Name:
description: The name of the Outpost.
type: string
pattern: ^[\S ]+$
minLength: 1
maxLength: 255
Description:
description: The description of the Outpost.
type: string
pattern: ^[\S ]*$
minLength: 0
maxLength: 1000
SupportedHardwareType:
description: ' The type of hardware for this Outpost. '
type: string
enum:
- RACK
- SERVER
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Update Outpost
tags:
- Outposts
/outposts/{OutpostId}/instanceTypes:
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: GetOutpostInstanceTypes
description: Gets the instance types for the specified Outpost.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetOutpostInstanceTypesOutput'
examples:
GetOutpostInstanceTypes200Example:
summary: Default GetOutpostInstanceTypes 200 response
x-microcks-default: true
value:
InstanceTypes: example-ref
NextToken: example-ref
OutpostId: resource-abc123
OutpostArn: 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: OutpostId
in: path
required: true
description: ' The ID or the Amazon Resource Name (ARN) of the Outpost. '
schema:
type: string
pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
minLength: 1
maxLength: 180
- 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
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Get Outpost Instance Types
tags:
- Outposts
/outposts/{OutpostId}/assets:
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: ListAssets
description: <p>Lists the hardware assets for the specified Outpost.</p> <p>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.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAssetsOutput'
examples:
ListAssets200Example:
summary: Default ListAssets 200 response
x-microcks-default: true
value:
Assets: example-string
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: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters:
- name: OutpostId
in: path
required: true
description: ' The ID or the Amazon Resource Name (ARN) of the Outpost. '
schema:
type: string
pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
minLength: 1
maxLength: 180
- name: HostIdFilter
in: query
required: false
description: Filters the results by the host ID of a Dedicated Host.
schema:
type: array
items:
$ref: '#/components/schemas/HostId'
- name: MaxResults
in: query
required: false
description: ''
schema:
type: integer
description: The maximum page size.
minimum: 1
maximum: 1000
- name: NextToken
in: query
required: false
description: ''
schema:
type: string
pattern: ^(\d+)##(\S+)$
description: The pagination token.
minLength: 1
maxLength: 2048
- name: StatusFilter
in: query
required: false
description: Filters the results by state.
schema:
type: array
items:
$ref: '#/components/schemas/AssetState'
minItems: 1
maxItems: 2
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts List Assets
tags:
- Outposts
components:
schemas:
OutpostName:
type: string
pattern: ^[\S ]+$
description: The name of the Outpost.
minLength: 1
maxLength: 255
NotFoundException: {}
AssetState:
type: string
enum:
- ACTIVE
- RETIRING
AccessDeniedException: {}
GetOutpostOutput:
type: object
properties:
Outpost:
$ref: '#/components/schemas/Outpost'
InstanceTypeItem:
type: object
properties:
InstanceType:
$ref: '#/components/schemas/InstanceType'
description: Information about an instance type.
HostId:
type: string
pattern: ^[A-Za-z0-9-]*$
minLength: 1
maxLength: 50
GetOutpostInstanceTypesOutput:
type: object
properties:
InstanceTypes:
$ref: '#/components/schemas/InstanceTypeListDefinition'
NextToken:
$ref: '#/components/schemas/Token'
OutpostId:
allOf:
- $ref: '#/components/schemas/OutpostId'
- description: ' The ID of the Outpost. '
OutpostArn:
$ref: '#/components/schemas/OutpostArn'
CreateOutpostOutput:
type: object
properties:
Outpost:
$ref: '#/components/schemas/Outpost'
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
InstanceType:
type: string
description: The instance type.
ConflictException: {}
ComputeAttributes:
type: object
properties:
HostId:
allOf:
- $ref: '#/components/schemas/HostId'
- description: ' The host ID of the Dedicated Host on the asset. '
State:
allOf:
- $ref: '#/components/schemas/ComputeAssetState'
- description: <p>The state.</p> <ul> <li> <p>ACTIVE - The asset is available and can provide capacity for new compute resources.</p> </li> <li> <p>ISOLATED - The asset is undergoing maintenance and can't provide capacity for new compute resources. Existing compute resources on the asset are not affected.</p> </li> <li> <p>RETIRING - The underlying hardware for the asset is degraded. Capacity for new compute resources is reduced. Amazon Web Services sends notifications for resources that must be stopped before the asset can be replaced.</p> </li> </ul>
description: ' Information about compute hardware assets. '
ListOutpostsOutput:
type: object
properties:
Outposts:
$ref: '#/components/schemas/outpostListDefinition'
NextToken:
$ref: '#/components/schemas/Token'
RackId:
type: string
pattern: ^[\S \n]+$
minLength: 5
maxLength: 20
TagMap:
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
AssetInfo:
type: object
properties:
AssetId:
allOf:
- $ref: '#/components/schemas/AssetId'
- description: ' The ID of the asset. '
RackId:
allOf:
- $ref: '#/components/schemas/RackId'
- description: ' The rack ID of the asset. '
AssetType:
allOf:
- $ref: '#/components/schemas/AssetType'
- description: ' The type of the asset. '
ComputeAttributes:
allOf:
- $ref: '#/components/schemas/ComputeAttributes'
- description: ' Information about compute hardware assets. '
AssetLocation:
allOf:
- $ref: '#/components/schemas/AssetLocation'
- description: ' The position of an asset in a rack. '
description: ' Information about hardware assets. '
AvailabilityZone:
type: string
pattern: ^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\d+[a-zA-Z]?)?$
description: The Availability Zone.
minLength: 1
maxLength: 1000
outpostListDefinition:
type: array
description: Information about the Outposts.
items:
$ref: '#/components/schemas/Outpost'
ServiceQuotaExceededException: {}
UpdateOutpostOutput:
type: object
properties:
Outpost:
$ref: '#/components/schemas/Outpost'
OwnerId:
type: string
pattern: \d{12}
description: The Amazon Web Services account ID of the Outpost owner.
minLength: 12
maxLength: 12
AssetType:
type: string
enum:
- COMPUTE
Outpost:
type: object
properties:
OutpostId:
allOf:
- $ref: '#/components/schemas/OutpostId'
- description: ' The ID of the Outpost. '
OwnerId:
$ref: '#/components/schemas/OwnerId'
OutpostArn:
$ref: '#/components/schemas/OutpostArn'
SiteId:
$ref: '#/components/schemas/SiteId'
Name:
$ref: '#/components/schemas/OutpostName'
Description:
$ref: '#/components/schemas/OutpostDescription'
LifeCycleStatus:
$ref: '#/components/schemas/LifeCycleStatus'
AvailabilityZone:
$ref: '#/components/schemas/AvailabilityZone'
AvailabilityZoneId:
$ref: '#/components/schemas/AvailabilityZoneId'
Tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The Outpost tags.
SiteArn:
$ref: '#/components/schemas/SiteArn'
SupportedHardwareType:
allOf:
- $ref: '#/components/schemas/SupportedHardwareType'
- description: ' The hardware type. '
description: Information about an Outpost.
InternalServerException: {}
DeleteOutpostOutput:
type: object
properties: {}
Token:
type: string
pattern: ^(\d+)##(\S+)$
description: The pagination token.
minLength: 1
maxLength: 2048
OutpostId:
type: string
pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
minLength: 1
maxLength: 180
LifeCycleStatus:
type: string
pattern: ^[ A-Za-z]+$
description: The life cycle status.
minLength: 1
maxLength: 20
SupportedHardwareType:
type: string
enum:
- RACK
- SERVER
ListAssetsOutput:
type: object
properties:
Assets:
allOf:
- $ref: '#/components/schemas/AssetListDefinition'
- description: Information about the hardware assets.
NextToken:
$ref: '#/components/schemas/Token'
AvailabilityZoneId:
type: string
pattern: ^[a-zA-Z]+\d-[a-zA-Z]+\d$
description: The ID of the Availability Zone.
minLength: 1
maxLength: 255
AssetListDefinition:
type: array
items:
$ref: '#/components/schemas/AssetInfo'
InstanceTypeListDefinition:
type: array
description: Information about the instance types.
items:
$ref: '#/components/schemas/InstanceTypeItem'
ComputeAssetState:
type: string
enum:
- ACTIVE
- ISOLATED
- RETIRING
OutpostArn:
type: string
pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$
description: The Amazon Resource Name (ARN) of the Outpost.
minLength: 1
maxLength: 255
OutpostDescription:
type: string
pattern: ^[\S ]*$
description: The description of the Outpost.
minLength: 0
maxLength: 1000
ValidationException: {}
RackElevation:
type: number
format: float
minimum: 0
maximum: 99
AssetLocation:
type: object
properties:
RackElevation:
allOf:
- $ref: '#/components/schemas/RackElevation'
- description: ' The position of an asset in a rack measured in rack units. '
description: ' Information about the position of the asset in a rack. '
AssetId:
type: string
pattern: ^(\w+)$
minLength: 1
maxLength: 100
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
TagValue:
type: string
pattern: ^[\S \n]+$
maxLength: 256
parameters:
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-outposts/refs/heads/main/openapi/amazon-outposts-outposts-api-openapi.yml