amazonka-outposts-2.0: Amazon Outposts SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Outposts.Lens

Description

 
Synopsis

Operations

CancelOrder

CreateOrder

createOrder_outpostIdentifier :: Lens' CreateOrder Text Source #

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

createOrder_lineItems :: Lens' CreateOrder (NonEmpty LineItemRequest) Source #

The line items that make up the order.

CreateOutpost

createOutpost_tags :: Lens' CreateOutpost (Maybe (HashMap Text Text)) Source #

The tags to apply to the Outpost.

createOutpost_siteId :: Lens' CreateOutpost Text Source #

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

CreateSite

createSite_notes :: Lens' CreateSite (Maybe Text) Source #

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.

createSite_operatingAddress :: Lens' CreateSite (Maybe Address) Source #

The location to install and power on the hardware. This address might be different from the shipping address.

createSite_rackPhysicalProperties :: Lens' CreateSite (Maybe RackPhysicalProperties) Source #

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

createSite_shippingAddress :: Lens' CreateSite (Maybe Address) Source #

The location to ship the hardware. This address might be different from the operating address.

createSite_tags :: Lens' CreateSite (Maybe (HashMap Text Text)) Source #

The tags to apply to a site.

createSite_name :: Lens' CreateSite Text Source #

Undocumented member.

DeleteOutpost

deleteOutpost_outpostId :: Lens' DeleteOutpost Text Source #

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

DeleteSite

deleteSite_siteId :: Lens' DeleteSite Text Source #

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

GetCatalogItem

GetConnection

GetOrder

getOrder_orderId :: Lens' GetOrder Text Source #

The ID of the order.

getOrderResponse_httpStatus :: Lens' GetOrderResponse Int Source #

The response's http status code.

GetOutpost

getOutpost_outpostId :: Lens' GetOutpost Text Source #

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

GetOutpostInstanceTypes

getOutpostInstanceTypes_outpostId :: Lens' GetOutpostInstanceTypes Text Source #

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

GetSite

getSite_siteId :: Lens' GetSite Text Source #

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

getSiteResponse_httpStatus :: Lens' GetSiteResponse Int Source #

The response's http status code.

GetSiteAddress

getSiteAddress_siteId :: Lens' GetSiteAddress Text Source #

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

getSiteAddress_addressType :: Lens' GetSiteAddress AddressType Source #

The type of the address you request.

ListAssets

listAssets_hostIdFilter :: Lens' ListAssets (Maybe [Text]) Source #

Filters the results by the host ID of a Dedicated Host.

listAssets_outpostIdentifier :: Lens' ListAssets Text Source #

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

listAssetsResponse_assets :: Lens' ListAssetsResponse (Maybe [AssetInfo]) Source #

Information about the hardware assets.

ListCatalogItems

listCatalogItems_eC2FamilyFilter :: Lens' ListCatalogItems (Maybe [Text]) Source #

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

ListOrders

listOrders_outpostIdentifierFilter :: Lens' ListOrders (Maybe Text) Source #

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

ListOutposts

listOutposts_availabilityZoneFilter :: Lens' ListOutposts (Maybe (NonEmpty Text)) Source #

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

listOutposts_availabilityZoneIdFilter :: Lens' ListOutposts (Maybe (NonEmpty Text)) Source #

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

listOutposts_lifeCycleStatusFilter :: Lens' ListOutposts (Maybe (NonEmpty Text)) Source #

Filters the results by the lifecycle status.

ListSites

listSites_operatingAddressCountryCodeFilter :: Lens' ListSites (Maybe [Text]) Source #

Filters the results by country code.

listSites_operatingAddressStateOrRegionFilter :: Lens' ListSites (Maybe [Text]) Source #

Filters the results by state or region.

listSitesResponse_httpStatus :: Lens' ListSitesResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

StartConnection

startConnection_assetId :: Lens' StartConnection Text Source #

The ID of the Outpost server.

startConnection_networkInterfaceDeviceIndex :: Lens' StartConnection Natural Source #

The device index of the network interface on the Outpost server.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags to add to the resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

UpdateOutpost

updateOutpost_outpostId :: Lens' UpdateOutpost Text Source #

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

UpdateSite

updateSite_name :: Lens' UpdateSite (Maybe Text) Source #

Undocumented member.

updateSite_siteId :: Lens' UpdateSite Text Source #

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

UpdateSiteAddress

updateSiteAddress_siteId :: Lens' UpdateSiteAddress Text Source #

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

UpdateSiteRackPhysicalProperties

updateSiteRackPhysicalProperties_fiberOpticCableType :: Lens' UpdateSiteRackPhysicalProperties (Maybe FiberOpticCableType) Source #

The type of fiber that you will use to attach the Outpost to your network.

updateSiteRackPhysicalProperties_maximumSupportedWeightLbs :: Lens' UpdateSiteRackPhysicalProperties (Maybe MaximumSupportedWeightLbs) Source #

The maximum rack weight that this site can support. NO_LIMIT is over 2000lbs.

updateSiteRackPhysicalProperties_opticalStandard :: Lens' UpdateSiteRackPhysicalProperties (Maybe OpticalStandard) Source #

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.

  • OPTIC_10GBASE_SR: 10GBASE-SR
  • OPTIC_10GBASE_IR: 10GBASE-IR
  • OPTIC_10GBASE_LR: 10GBASE-LR
  • OPTIC_40GBASE_SR: 40GBASE-SR
  • OPTIC_40GBASE_ESR: 40GBASE-ESR
  • OPTIC_40GBASE_IR4_LR4L: 40GBASE-IR (LR4L)
  • OPTIC_40GBASE_LR4: 40GBASE-LR4
  • OPTIC_100GBASE_SR4: 100GBASE-SR4
  • OPTIC_100GBASE_CWDM4: 100GBASE-CWDM4
  • OPTIC_100GBASE_LR4: 100GBASE-LR4
  • OPTIC_100G_PSM4_MSA: 100G PSM4 MSA
  • OPTIC_1000BASE_LX: 1000Base-LX
  • OPTIC_1000BASE_SX : 1000Base-SX

updateSiteRackPhysicalProperties_powerConnector :: Lens' UpdateSiteRackPhysicalProperties (Maybe PowerConnector) Source #

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

  • Single-phase AC feed

    • L6-30P – (common in US); 30A; single phase
    • IEC309 (blue) – P+N+E, 6hr; 32 A; single phase
  • Three-phase AC feed

    • AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase
    • AH532P6W (red) – 3P+N+E, 6hr; 32A; three phase

updateSiteRackPhysicalProperties_powerDrawKva :: Lens' UpdateSiteRackPhysicalProperties (Maybe PowerDrawKva) Source #

The power draw, in kVA, available at the hardware placement position for the rack.

updateSiteRackPhysicalProperties_powerFeedDrop :: Lens' UpdateSiteRackPhysicalProperties (Maybe PowerFeedDrop) Source #

Indicates whether the power feed comes above or below the rack.

updateSiteRackPhysicalProperties_powerPhase :: Lens' UpdateSiteRackPhysicalProperties (Maybe PowerPhase) Source #

The power option that you can provide for hardware.

  • Single-phase AC feed: 200 V to 277 V, 50 Hz or 60 Hz
  • Three-phase AC feed: 346 V to 480 V, 50 Hz or 60 Hz

updateSiteRackPhysicalProperties_uplinkCount :: Lens' UpdateSiteRackPhysicalProperties (Maybe UplinkCount) Source #

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.

  • 1Gbps - Uplinks available: 1, 2, 4, 6, 8
  • 10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16
  • 40 and 100 Gbps- Uplinks available: 1, 2, 4

updateSiteRackPhysicalProperties_uplinkGbps :: Lens' UpdateSiteRackPhysicalProperties (Maybe UplinkGbps) Source #

The uplink speed the rack should support for the connection to the Region.

updateSiteRackPhysicalProperties_siteId :: Lens' UpdateSiteRackPhysicalProperties Text Source #

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

Types

Address

address_addressLine2 :: Lens' Address (Maybe Text) Source #

The second line of the address.

address_addressLine3 :: Lens' Address (Maybe Text) Source #

The third line of the address.

address_contactName :: Lens' Address (Maybe Text) Source #

The name of the contact.

address_contactPhoneNumber :: Lens' Address (Maybe Text) Source #

The phone number of the contact.

address_districtOrCounty :: Lens' Address (Maybe Text) Source #

The district or county for the address.

address_municipality :: Lens' Address (Maybe Text) Source #

The municipality for the address.

address_addressLine1 :: Lens' Address Text Source #

The first line of the address.

address_city :: Lens' Address Text Source #

The city for the address.

address_stateOrRegion :: Lens' Address Text Source #

The state for the address.

address_postalCode :: Lens' Address Text Source #

The postal code for the address.

address_countryCode :: Lens' Address Text Source #

The ISO-3166 two-letter country code for the address.

AssetInfo

assetInfo_assetLocation :: Lens' AssetInfo (Maybe AssetLocation) Source #

The position of an asset in a rack.

assetInfo_computeAttributes :: Lens' AssetInfo (Maybe ComputeAttributes) Source #

Information about compute hardware assets.

assetInfo_rackId :: Lens' AssetInfo (Maybe Text) Source #

The rack ID of the asset.

AssetLocation

assetLocation_rackElevation :: Lens' AssetLocation (Maybe Double) Source #

The position of an asset in a rack measured in rack units.

CatalogItem

catalogItem_catalogItemId :: Lens' CatalogItem (Maybe Text) Source #

The ID of the catalog item.

catalogItem_eC2Capacities :: Lens' CatalogItem (Maybe [EC2Capacity]) Source #

Information about the EC2 capacity of an item.

catalogItem_powerKva :: Lens' CatalogItem (Maybe Double) Source #

Information about the power draw of an item.

catalogItem_supportedStorage :: Lens' CatalogItem (Maybe [SupportedStorageEnum]) Source #

The supported storage options for the catalog item.

catalogItem_supportedUplinkGbps :: Lens' CatalogItem (Maybe [Int]) Source #

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

catalogItem_weightLbs :: Lens' CatalogItem (Maybe Int) Source #

The weight of the item in pounds.

ComputeAttributes

computeAttributes_hostId :: Lens' ComputeAttributes (Maybe Text) Source #

The host ID of the Dedicated Host on the asset.

computeAttributes_state :: Lens' ComputeAttributes (Maybe ComputeAssetState) Source #

The state.

  • ACTIVE - The asset is available and can provide capacity for new compute resources.
  • ISOLATED - The asset is undergoing maintenance and can't provide capacity for new compute resources. Existing compute resources on the asset are not affected.
  • 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.

ConnectionDetails

EC2Capacity

eC2Capacity_family :: Lens' EC2Capacity (Maybe Text) Source #

The family of the EC2 capacity.

eC2Capacity_maxSize :: Lens' EC2Capacity (Maybe Text) Source #

The maximum size of the EC2 capacity.

eC2Capacity_quantity :: Lens' EC2Capacity (Maybe Text) Source #

The quantity of the EC2 capacity.

InstanceTypeItem

LineItem

lineItem_catalogItemId :: Lens' LineItem (Maybe Text) Source #

The ID of the catalog item.

lineItem_lineItemId :: Lens' LineItem (Maybe Text) Source #

The ID of the line item.

lineItem_quantity :: Lens' LineItem (Maybe Natural) Source #

The quantity of the line item.

lineItem_shipmentInformation :: Lens' LineItem (Maybe ShipmentInformation) Source #

Information about a line item shipment.

lineItem_status :: Lens' LineItem (Maybe LineItemStatus) Source #

The status of the line item.

LineItemAssetInformation

LineItemRequest

lineItemRequest_quantity :: Lens' LineItemRequest (Maybe Natural) Source #

The quantity of a line item request.

Order

order_lineItems :: Lens' Order (Maybe [LineItem]) Source #

The line items for the order

order_orderFulfilledDate :: Lens' Order (Maybe UTCTime) Source #

The fulfillment date of the order.

order_orderId :: Lens' Order (Maybe Text) Source #

The ID of the order.

order_orderSubmissionDate :: Lens' Order (Maybe UTCTime) Source #

The submission date for the order.

order_outpostId :: Lens' Order (Maybe Text) Source #

The ID of the Outpost in the order.

order_paymentOption :: Lens' Order (Maybe PaymentOption) Source #

The payment option for the order.

order_status :: Lens' Order (Maybe OrderStatus) Source #

The status of the order.

  • PREPARING - Order is received and being prepared.
  • IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the line item status.
  • COMPLETED - Order is complete.
  • CANCELLED - Order is cancelled.
  • ERROR - Customer should contact support.

The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

OrderSummary

orderSummary_orderFulfilledDate :: Lens' OrderSummary (Maybe UTCTime) Source #

The fulfilment date for the order.

orderSummary_status :: Lens' OrderSummary (Maybe OrderStatus) Source #

The status of the order.

  • PREPARING - Order is received and is being prepared.
  • IN_PROGRESS - Order is either being built, shipped, or installed. For more information, see the LineItem status.
  • COMPLETED - Order is complete.
  • CANCELLED - Order is cancelled.
  • ERROR - Customer should contact support.

The following statuses are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

Outpost

outpost_name :: Lens' Outpost (Maybe Text) Source #

Undocumented member.

outpost_outpostArn :: Lens' Outpost (Maybe Text) Source #

Undocumented member.

outpost_outpostId :: Lens' Outpost (Maybe Text) Source #

The ID of the Outpost.

outpost_ownerId :: Lens' Outpost (Maybe Text) Source #

Undocumented member.

outpost_siteArn :: Lens' Outpost (Maybe Text) Source #

Undocumented member.

outpost_siteId :: Lens' Outpost (Maybe Text) Source #

Undocumented member.

RackPhysicalProperties

rackPhysicalProperties_fiberOpticCableType :: Lens' RackPhysicalProperties (Maybe FiberOpticCableType) Source #

The type of fiber used to attach the Outpost to the network.

rackPhysicalProperties_maximumSupportedWeightLbs :: Lens' RackPhysicalProperties (Maybe MaximumSupportedWeightLbs) Source #

The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

rackPhysicalProperties_opticalStandard :: Lens' RackPhysicalProperties (Maybe OpticalStandard) Source #

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.

rackPhysicalProperties_powerDrawKva :: Lens' RackPhysicalProperties (Maybe PowerDrawKva) Source #

The power draw available at the hardware placement position for the rack.

rackPhysicalProperties_powerPhase :: Lens' RackPhysicalProperties (Maybe PowerPhase) Source #

The power option that you can provide for hardware.

rackPhysicalProperties_uplinkCount :: Lens' RackPhysicalProperties (Maybe UplinkCount) Source #

The number of uplinks each Outpost network device.

rackPhysicalProperties_uplinkGbps :: Lens' RackPhysicalProperties (Maybe UplinkGbps) Source #

The uplink speed the rack supports for the connection to the Region.

ShipmentInformation

Site

site_accountId :: Lens' Site (Maybe Text) Source #

Undocumented member.

site_description :: Lens' Site (Maybe Text) Source #

Undocumented member.

site_name :: Lens' Site (Maybe Text) Source #

Undocumented member.

site_notes :: Lens' Site (Maybe Text) Source #

Notes about a site.

site_operatingAddressCity :: Lens' Site (Maybe Text) Source #

City where the hardware is installed and powered on.

site_operatingAddressCountryCode :: Lens' Site (Maybe Text) Source #

The ISO-3166 two-letter country code where the hardware is installed and powered on.

site_operatingAddressStateOrRegion :: Lens' Site (Maybe Text) Source #

State or region where the hardware is installed and powered on.

site_rackPhysicalProperties :: Lens' Site (Maybe RackPhysicalProperties) Source #

Information about the physical and logistical details for a rack at the site.

site_siteArn :: Lens' Site (Maybe Text) Source #

Undocumented member.

site_siteId :: Lens' Site (Maybe Text) Source #

Undocumented member.