{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-outposts","description":"AWS Outposts","version":"2019-12-03","base_url":"","endpoints":31,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS Outposts\n@version 2019-12-03\n@auth AWS SigV4\n@endpoints 31\n@hint download_for_search\n@toc outposts(11), orders(3), sites(8), catalog(2), connections(2), capacity(1), list-orders(1), tags(3)\n\n@group outposts\n@endpoint POST /outposts/{OutpostId}/capacity/{CapacityTaskId}\n@desc Cancels the capacity task.\n@required {CapacityTaskId: str, OutpostIdentifier: str}\n\n@endgroup\n\n@group orders\n@endpoint POST /orders/{OrderId}/cancel\n@desc Cancels the specified order for an Outpost.\n@required {OrderId: str}\n\n@endpoint POST /orders\n@desc Creates an order for an Outpost.\n@required {OutpostIdentifier: str, LineItems: [LineItemRequest], PaymentOption: str}\n@optional {PaymentTerm: str}\n@returns(200) {Order: Order?{OutpostId: str?, OrderId: str?, Status: str?, LineItems: [LineItem]?, PaymentOption: str?, OrderSubmissionDate: str(timestamp)?, OrderFulfilledDate: str(timestamp)?, PaymentTerm: str?, OrderType: str?}}\n\n@endgroup\n\n@group outposts\n@endpoint POST /outposts\n@desc Creates an Outpost. You can specify either an Availability one or an AZ ID.\n@required {Name: str, SiteId: str}\n@optional {Description: str, AvailabilityZone: str, AvailabilityZoneId: str, Tags: map<str,str>, SupportedHardwareType: str}\n@returns(200) {Outpost: Outpost?{OutpostId: str?, OwnerId: str?, OutpostArn: str?, SiteId: str?, Name: str?, Description: str?, LifeCycleStatus: str?, AvailabilityZone: str?, AvailabilityZoneId: str?, Tags: map<str,str>?, SiteArn: str?, SupportedHardwareType: str?}}\n\n@endgroup\n\n@group sites\n@endpoint POST /sites\n@desc Creates a site for an Outpost.\n@required {Name: str}\n@optional {Description: str, Notes: str, Tags: map<str,str>, OperatingAddress: Address, ShippingAddress: Address, RackPhysicalProperties: RackPhysicalProperties}\n@returns(200) {Site: Site?{SiteId: str?, AccountId: str?, Name: str?, Description: str?, Tags: map<str,str>?, SiteArn: str?, Notes: str?, OperatingAddressCountryCode: str?, OperatingAddressStateOrRegion: str?, OperatingAddressCity: str?, RackPhysicalProperties: RackPhysicalProperties?{PowerDrawKva: str?, PowerPhase: str?, PowerConnector: str?, PowerFeedDrop: str?, UplinkGbps: str?, UplinkCount: str?, FiberOpticCableType: str?, OpticalStandard: str?, MaximumSupportedWeightLbs: str?}}}\n\n@endgroup\n\n@group outposts\n@endpoint DELETE /outposts/{OutpostId}\n@desc Deletes the specified Outpost.\n@required {OutpostId: str}\n\n@endgroup\n\n@group sites\n@endpoint DELETE /sites/{SiteId}\n@desc Deletes the specified site.\n@required {SiteId: str}\n\n@endgroup\n\n@group outposts\n@endpoint GET /outposts/{OutpostId}/capacity/{CapacityTaskId}\n@desc Gets details of the specified capacity task.\n@required {CapacityTaskId: str, OutpostIdentifier: str}\n@returns(200) {CapacityTaskId: str?, OutpostId: str?, OrderId: str?, RequestedInstancePools: [InstanceTypeCapacity]?, DryRun: bool?, CapacityTaskStatus: str?, Failed: CapacityTaskFailure?{Reason: str, Type: str?}, CreationDate: str(timestamp)?, CompletionDate: str(timestamp)?, LastModifiedDate: str(timestamp)?}\n\n@endgroup\n\n@group catalog\n@endpoint GET /catalog/item/{CatalogItemId}\n@desc Gets information about the specified catalog item.\n@required {CatalogItemId: str}\n@returns(200) {CatalogItem: CatalogItem?{CatalogItemId: str?, ItemStatus: str?, EC2Capacities: [EC2Capacity]?, PowerKva: num(f32)?, WeightLbs: int?, SupportedUplinkGbps: [int]?, SupportedStorage: [str]?}}\n\n@endgroup\n\n@group connections\n@endpoint GET /connections/{ConnectionId}\n@desc Amazon Web Services uses this action to install Outpost servers.   Gets information about the specified connection.   Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see  Amazon Web Services managed policies for Amazon Web Services Outposts and  Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.\n@required {ConnectionId: str}\n@returns(200) {ConnectionId: str?, ConnectionDetails: ConnectionDetails?{ClientPublicKey: str?, ServerPublicKey: str?, ServerEndpoint: str?, ClientTunnelAddress: str?, ServerTunnelAddress: str?, AllowedIps: [str]?}}\n\n@endgroup\n\n@group orders\n@endpoint GET /orders/{OrderId}\n@desc Gets information about the specified order.\n@required {OrderId: str}\n@returns(200) {Order: Order?{OutpostId: str?, OrderId: str?, Status: str?, LineItems: [LineItem]?, PaymentOption: str?, OrderSubmissionDate: str(timestamp)?, OrderFulfilledDate: str(timestamp)?, PaymentTerm: str?, OrderType: str?}}\n\n@endgroup\n\n@group outposts\n@endpoint GET /outposts/{OutpostId}\n@desc Gets information about the specified Outpost.\n@required {OutpostId: str}\n@returns(200) {Outpost: Outpost?{OutpostId: str?, OwnerId: str?, OutpostArn: str?, SiteId: str?, Name: str?, Description: str?, LifeCycleStatus: str?, AvailabilityZone: str?, AvailabilityZoneId: str?, Tags: map<str,str>?, SiteArn: str?, SupportedHardwareType: str?}}\n\n@endpoint GET /outposts/{OutpostId}/instanceTypes\n@desc Gets the instance types for the specified Outpost.\n@required {OutpostId: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {InstanceTypes: [InstanceTypeItem]?, NextToken: str?, OutpostId: str?, OutpostArn: str?}\n\n@endpoint GET /outposts/{OutpostId}/supportedInstanceTypes\n@desc Gets the instance types that an Outpost can support in InstanceTypeCapacity. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.\n@required {OutpostIdentifier: str, OrderId: str}\n@optional {MaxResults: int, NextToken: str}\n@returns(200) {InstanceTypes: [InstanceTypeItem]?, NextToken: str?}\n\n@endgroup\n\n@group sites\n@endpoint GET /sites/{SiteId}\n@desc Gets information about the specified Outpost site.\n@required {SiteId: str}\n@returns(200) {Site: Site?{SiteId: str?, AccountId: str?, Name: str?, Description: str?, Tags: map<str,str>?, SiteArn: str?, Notes: str?, OperatingAddressCountryCode: str?, OperatingAddressStateOrRegion: str?, OperatingAddressCity: str?, RackPhysicalProperties: RackPhysicalProperties?{PowerDrawKva: str?, PowerPhase: str?, PowerConnector: str?, PowerFeedDrop: str?, UplinkGbps: str?, UplinkCount: str?, FiberOpticCableType: str?, OpticalStandard: str?, MaximumSupportedWeightLbs: str?}}}\n\n@endpoint GET /sites/{SiteId}/address\n@desc Gets the site address of the specified site.\n@required {SiteId: str, AddressType: str}\n@returns(200) {SiteId: str?, AddressType: str?, Address: Address?{ContactName: str?, ContactPhoneNumber: str?, AddressLine1: str, AddressLine2: str?, AddressLine3: str?, City: str, StateOrRegion: str, DistrictOrCounty: str?, PostalCode: str, CountryCode: str, Municipality: str?}}\n\n@endgroup\n\n@group outposts\n@endpoint GET /outposts/{OutpostId}/assets\n@desc Lists the hardware assets for the specified Outpost. 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.\n@required {OutpostIdentifier: str}\n@optional {HostIdFilter: [str], MaxResults: int, NextToken: str, StatusFilter: [str]}\n@returns(200) {Assets: [AssetInfo]?, NextToken: str?}\n\n@endgroup\n\n@group capacity\n@endpoint GET /capacity/tasks\n@desc Lists the capacity tasks 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.\n@optional {OutpostIdentifierFilter: str, MaxResults: int, NextToken: str, CapacityTaskStatusFilter: [str]}\n@returns(200) {CapacityTasks: [CapacityTaskSummary]?, NextToken: str?}\n\n@endgroup\n\n@group catalog\n@endpoint GET /catalog/items\n@desc 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.\n@optional {NextToken: str, MaxResults: int, ItemClassFilter: [str], SupportedStorageFilter: [str], EC2FamilyFilter: [str]}\n@returns(200) {CatalogItems: [CatalogItem]?, NextToken: str?}\n\n@endgroup\n\n@group list-orders\n@endpoint GET /list-orders\n@desc Lists the Outpost orders for your Amazon Web Services account.\n@optional {OutpostIdentifierFilter: str, NextToken: str, MaxResults: int}\n@returns(200) {Orders: [OrderSummary]?, NextToken: str?}\n\n@endgroup\n\n@group outposts\n@endpoint GET /outposts\n@desc 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.\n@optional {NextToken: str, MaxResults: int, LifeCycleStatusFilter: [str], AvailabilityZoneFilter: [str], AvailabilityZoneIdFilter: [str]}\n@returns(200) {Outposts: [Outpost]?, NextToken: str?}\n\n@endgroup\n\n@group sites\n@endpoint GET /sites\n@desc 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.\n@optional {NextToken: str, MaxResults: int, OperatingAddressCountryCodeFilter: [str], OperatingAddressStateOrRegionFilter: [str], OperatingAddressCityFilter: [str]}\n@returns(200) {Sites: [Site]?, NextToken: str?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{ResourceArn}\n@desc Lists the tags for the specified resource.\n@required {ResourceArn: str}\n@returns(200) {Tags: map<str,str>?}\n\n@endgroup\n\n@group outposts\n@endpoint POST /outposts/{OutpostId}/capacity\n@desc Starts the specified capacity task. You can have one active capacity task for an order.\n@required {OutpostIdentifier: str, OrderId: str, InstancePools: [InstanceTypeCapacity]}\n@optional {DryRun: bool}\n@returns(200) {CapacityTaskId: str?, OutpostId: str?, OrderId: str?, RequestedInstancePools: [InstanceTypeCapacity]?, DryRun: bool?, CapacityTaskStatus: str?, Failed: CapacityTaskFailure?{Reason: str, Type: str?}, CreationDate: str(timestamp)?, CompletionDate: str(timestamp)?, LastModifiedDate: str(timestamp)?}\n\n@endgroup\n\n@group connections\n@endpoint POST /connections\n@desc Amazon Web Services uses this action to install Outpost servers.   Starts the connection required for Outpost server installation.   Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see  Amazon Web Services managed policies for Amazon Web Services Outposts and  Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.\n@required {AssetId: str, ClientPublicKey: str, NetworkInterfaceDeviceIndex: int}\n@optional {DeviceSerialNumber: str}\n@returns(200) {ConnectionId: str?, UnderlayIpAddress: str?}\n\n@endgroup\n\n@group tags\n@endpoint POST /tags/{ResourceArn}\n@desc Adds tags to the specified resource.\n@required {ResourceArn: str, Tags: map<str,str>}\n\n@endpoint DELETE /tags/{ResourceArn}\n@desc Removes tags from the specified resource.\n@required {ResourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group outposts\n@endpoint PATCH /outposts/{OutpostId}\n@desc Updates an Outpost.\n@required {OutpostId: str}\n@optional {Name: str, Description: str, SupportedHardwareType: str}\n@returns(200) {Outpost: Outpost?{OutpostId: str?, OwnerId: str?, OutpostArn: str?, SiteId: str?, Name: str?, Description: str?, LifeCycleStatus: str?, AvailabilityZone: str?, AvailabilityZoneId: str?, Tags: map<str,str>?, SiteArn: str?, SupportedHardwareType: str?}}\n\n@endgroup\n\n@group sites\n@endpoint PATCH /sites/{SiteId}\n@desc Updates the specified site.\n@required {SiteId: str}\n@optional {Name: str, Description: str, Notes: str}\n@returns(200) {Site: Site?{SiteId: str?, AccountId: str?, Name: str?, Description: str?, Tags: map<str,str>?, SiteArn: str?, Notes: str?, OperatingAddressCountryCode: str?, OperatingAddressStateOrRegion: str?, OperatingAddressCity: str?, RackPhysicalProperties: RackPhysicalProperties?{PowerDrawKva: str?, PowerPhase: str?, PowerConnector: str?, PowerFeedDrop: str?, UplinkGbps: str?, UplinkCount: str?, FiberOpticCableType: str?, OpticalStandard: str?, MaximumSupportedWeightLbs: str?}}}\n\n@endpoint PUT /sites/{SiteId}/address\n@desc 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.\n@required {SiteId: str, AddressType: str, Address: Address}\n@returns(200) {AddressType: str?, Address: Address?{ContactName: str?, ContactPhoneNumber: str?, AddressLine1: str, AddressLine2: str?, AddressLine3: str?, City: str, StateOrRegion: str, DistrictOrCounty: str?, PostalCode: str, CountryCode: str, Municipality: str?}}\n\n@endpoint PATCH /sites/{SiteId}/rackPhysicalProperties\n@desc 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.\n@required {SiteId: str}\n@optional {PowerDrawKva: str, PowerPhase: str, PowerConnector: str, PowerFeedDrop: str, UplinkGbps: str, UplinkCount: str, FiberOpticCableType: str, OpticalStandard: str, MaximumSupportedWeightLbs: str}\n@returns(200) {Site: Site?{SiteId: str?, AccountId: str?, Name: str?, Description: str?, Tags: map<str,str>?, SiteArn: str?, Notes: str?, OperatingAddressCountryCode: str?, OperatingAddressStateOrRegion: str?, OperatingAddressCity: str?, RackPhysicalProperties: RackPhysicalProperties?{PowerDrawKva: str?, PowerPhase: str?, PowerConnector: str?, PowerFeedDrop: str?, UplinkGbps: str?, UplinkCount: str?, FiberOpticCableType: str?, OpticalStandard: str?, MaximumSupportedWeightLbs: str?}}}\n\n@endgroup\n\n@end\n"}