github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/outposts/2019-12-03/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<p>AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.</p>",
     4    "operations": {
     5      "CreateOrder": "<p>Creates an order for an Outpost.</p>",
     6      "CreateOutpost": "<p>Creates an Outpost.</p> <p>You can specify <code>AvailabilityZone</code> or <code>AvailabilityZoneId</code>.</p>",
     7      "DeleteOutpost": "<p>Deletes the Outpost.</p>",
     8      "DeleteSite": "<p>Deletes the site.</p>",
     9      "GetOutpost": "<p>Gets information about the specified Outpost.</p>",
    10      "GetOutpostInstanceTypes": "<p>Lists the instance types for the specified Outpost.</p>",
    11      "ListOutposts": "<p>Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availibility Zone (<code>us-east-1a</code>), and AZ ID (<code>use1-az1</code>). </p> <p>If you specify multiple filters, the filters are joined with an <code>AND</code>, and the request returns only results that match all of the specified filters.</p>",
    12      "ListSites": "<p>Lists the sites for the specified AWS account.</p>",
    13      "ListTagsForResource": "<p>Lists the tags for the specified resource.</p>",
    14      "TagResource": "<p>Adds tags to the specified resource.</p>",
    15      "UntagResource": "<p>Removes tags from the specified resource.</p>"
    16    },
    17    "shapes": {
    18      "AccessDeniedException": {
    19        "base": "<p>You do not have permission to perform this operation.</p>",
    20        "refs": {
    21        }
    22      },
    23      "AccountId": {
    24        "base": "<p>The ID of the AWS account.</p>",
    25        "refs": {
    26          "Site$AccountId": null
    27        }
    28      },
    29      "Arn": {
    30        "base": null,
    31        "refs": {
    32          "ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
    33          "TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
    34          "UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>"
    35        }
    36      },
    37      "AvailabilityZone": {
    38        "base": "<p>The Availability Zone.</p>",
    39        "refs": {
    40          "AvailabilityZoneList$member": null,
    41          "CreateOutpostInput$AvailabilityZone": null,
    42          "Outpost$AvailabilityZone": null
    43        }
    44      },
    45      "AvailabilityZoneId": {
    46        "base": "<p>The ID of the Availability Zone.</p>",
    47        "refs": {
    48          "AvailabilityZoneIdList$member": null,
    49          "CreateOutpostInput$AvailabilityZoneId": null,
    50          "Outpost$AvailabilityZoneId": null
    51        }
    52      },
    53      "AvailabilityZoneIdList": {
    54        "base": null,
    55        "refs": {
    56          "ListOutpostsInput$AvailabilityZoneIdFilter": "<p> A filter for the AZ IDs (<code>use1-az1</code>) of the Outpost. </p> <p> Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values. </p>"
    57        }
    58      },
    59      "AvailabilityZoneList": {
    60        "base": null,
    61        "refs": {
    62          "ListOutpostsInput$AvailabilityZoneFilter": "<p> A filter for the Availibility Zone (<code>us-east-1a</code>) of the Outpost. </p> <p> Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values. </p>"
    63        }
    64      },
    65      "ConflictException": {
    66        "base": "<p>Updating or deleting this resource can cause an inconsistent state.</p>",
    67        "refs": {
    68        }
    69      },
    70      "CreateOrderInput": {
    71        "base": null,
    72        "refs": {
    73        }
    74      },
    75      "CreateOrderOutput": {
    76        "base": null,
    77        "refs": {
    78        }
    79      },
    80      "CreateOutpostInput": {
    81        "base": null,
    82        "refs": {
    83        }
    84      },
    85      "CreateOutpostOutput": {
    86        "base": null,
    87        "refs": {
    88        }
    89      },
    90      "DeleteOutpostInput": {
    91        "base": null,
    92        "refs": {
    93        }
    94      },
    95      "DeleteOutpostOutput": {
    96        "base": null,
    97        "refs": {
    98        }
    99      },
   100      "DeleteSiteInput": {
   101        "base": null,
   102        "refs": {
   103        }
   104      },
   105      "DeleteSiteOutput": {
   106        "base": null,
   107        "refs": {
   108        }
   109      },
   110      "ErrorMessage": {
   111        "base": null,
   112        "refs": {
   113          "AccessDeniedException$Message": null,
   114          "ConflictException$Message": null,
   115          "InternalServerException$Message": null,
   116          "NotFoundException$Message": null,
   117          "ServiceQuotaExceededException$Message": null,
   118          "ValidationException$Message": null
   119        }
   120      },
   121      "GetOutpostInput": {
   122        "base": null,
   123        "refs": {
   124        }
   125      },
   126      "GetOutpostInstanceTypesInput": {
   127        "base": null,
   128        "refs": {
   129        }
   130      },
   131      "GetOutpostInstanceTypesOutput": {
   132        "base": null,
   133        "refs": {
   134        }
   135      },
   136      "GetOutpostOutput": {
   137        "base": null,
   138        "refs": {
   139        }
   140      },
   141      "ISO8601Timestamp": {
   142        "base": null,
   143        "refs": {
   144          "Order$OrderSubmissionDate": "<p>The submission date for the order.</p>",
   145          "Order$OrderFulfilledDate": "<p>The fulfillment date of the order.</p>"
   146        }
   147      },
   148      "InstanceType": {
   149        "base": "<p>The instance type.</p>",
   150        "refs": {
   151          "InstanceTypeItem$InstanceType": null
   152        }
   153      },
   154      "InstanceTypeItem": {
   155        "base": "<p>Information about an instance type.</p>",
   156        "refs": {
   157          "InstanceTypeListDefinition$member": null
   158        }
   159      },
   160      "InstanceTypeListDefinition": {
   161        "base": "<p>Information about the instance types.</p>",
   162        "refs": {
   163          "GetOutpostInstanceTypesOutput$InstanceTypes": null
   164        }
   165      },
   166      "InternalServerException": {
   167        "base": "<p>An internal error has occurred.</p>",
   168        "refs": {
   169        }
   170      },
   171      "LifeCycleStatus": {
   172        "base": "<p>The life cycle status.</p>",
   173        "refs": {
   174          "LifeCycleStatusList$member": null,
   175          "Outpost$LifeCycleStatus": null
   176        }
   177      },
   178      "LifeCycleStatusList": {
   179        "base": null,
   180        "refs": {
   181          "ListOutpostsInput$LifeCycleStatusFilter": "<p> A filter for the lifecycle status of the Outpost. </p> <p> Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values. </p>"
   182        }
   183      },
   184      "LineItem": {
   185        "base": "<p>Information about a line item.</p>",
   186        "refs": {
   187          "LineItemListDefinition$member": null
   188        }
   189      },
   190      "LineItemId": {
   191        "base": null,
   192        "refs": {
   193          "LineItem$LineItemId": "<p>The ID of the line item.</p>"
   194        }
   195      },
   196      "LineItemListDefinition": {
   197        "base": null,
   198        "refs": {
   199          "Order$LineItems": "<p>The line items for the order</p>"
   200        }
   201      },
   202      "LineItemQuantity": {
   203        "base": null,
   204        "refs": {
   205          "LineItem$Quantity": "<p>The quantity of the line item.</p>",
   206          "LineItemRequest$Quantity": "<p>The quantity of a line item request.</p>"
   207        }
   208      },
   209      "LineItemRequest": {
   210        "base": "<p>Information about a line item request.</p>",
   211        "refs": {
   212          "LineItemRequestListDefinition$member": null
   213        }
   214      },
   215      "LineItemRequestListDefinition": {
   216        "base": null,
   217        "refs": {
   218          "CreateOrderInput$LineItems": "<p>The line items that make up the order.</p>"
   219        }
   220      },
   221      "ListOutpostsInput": {
   222        "base": null,
   223        "refs": {
   224        }
   225      },
   226      "ListOutpostsOutput": {
   227        "base": null,
   228        "refs": {
   229        }
   230      },
   231      "ListSitesInput": {
   232        "base": null,
   233        "refs": {
   234        }
   235      },
   236      "ListSitesOutput": {
   237        "base": null,
   238        "refs": {
   239        }
   240      },
   241      "ListTagsForResourceRequest": {
   242        "base": null,
   243        "refs": {
   244        }
   245      },
   246      "ListTagsForResourceResponse": {
   247        "base": null,
   248        "refs": {
   249        }
   250      },
   251      "MaxResults1000": {
   252        "base": "<p>The maximum page size.</p>",
   253        "refs": {
   254          "GetOutpostInstanceTypesInput$MaxResults": null,
   255          "ListOutpostsInput$MaxResults": null,
   256          "ListSitesInput$MaxResults": null
   257        }
   258      },
   259      "NotFoundException": {
   260        "base": "<p>The specified request is not valid.</p>",
   261        "refs": {
   262        }
   263      },
   264      "Order": {
   265        "base": "<p>Information about an order.</p>",
   266        "refs": {
   267          "CreateOrderOutput$Order": "<p>Information about this order.</p>"
   268        }
   269      },
   270      "OrderId": {
   271        "base": null,
   272        "refs": {
   273          "Order$OrderId": "<p>The ID of the order.</p>"
   274        }
   275      },
   276      "OrderStatus": {
   277        "base": null,
   278        "refs": {
   279          "Order$Status": "<p>The status of the order</p>"
   280        }
   281      },
   282      "Outpost": {
   283        "base": "<p>Information about an Outpost.</p>",
   284        "refs": {
   285          "CreateOutpostOutput$Outpost": null,
   286          "GetOutpostOutput$Outpost": null,
   287          "outpostListDefinition$member": null
   288        }
   289      },
   290      "OutpostArn": {
   291        "base": "<p>The Amazon Resource Name (ARN) of the Outpost.</p>",
   292        "refs": {
   293          "GetOutpostInstanceTypesOutput$OutpostArn": null,
   294          "Outpost$OutpostArn": null
   295        }
   296      },
   297      "OutpostDescription": {
   298        "base": "<p>The description of the Outpost.</p>",
   299        "refs": {
   300          "CreateOutpostInput$Description": null,
   301          "Outpost$Description": null
   302        }
   303      },
   304      "OutpostId": {
   305        "base": null,
   306        "refs": {
   307          "DeleteOutpostInput$OutpostId": "<p> The ID of the Outpost. </p>",
   308          "GetOutpostInput$OutpostId": "<p> The ID of the Outpost. </p>",
   309          "GetOutpostInstanceTypesInput$OutpostId": "<p> The ID of the Outpost. </p>",
   310          "GetOutpostInstanceTypesOutput$OutpostId": "<p> The ID of the Outpost. </p>",
   311          "Outpost$OutpostId": "<p> The ID of the Outpost. </p>"
   312        }
   313      },
   314      "OutpostIdOnly": {
   315        "base": null,
   316        "refs": {
   317          "Order$OutpostId": "<p> The ID of the Outpost. </p>"
   318        }
   319      },
   320      "OutpostIdentifier": {
   321        "base": null,
   322        "refs": {
   323          "CreateOrderInput$OutpostIdentifier": "<p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>"
   324        }
   325      },
   326      "OutpostName": {
   327        "base": "<p>The name of the Outpost.</p>",
   328        "refs": {
   329          "CreateOutpostInput$Name": null,
   330          "Outpost$Name": null
   331        }
   332      },
   333      "OwnerId": {
   334        "base": "<p>The AWS account ID of the Outpost owner.</p>",
   335        "refs": {
   336          "Outpost$OwnerId": null
   337        }
   338      },
   339      "PaymentOption": {
   340        "base": null,
   341        "refs": {
   342          "CreateOrderInput$PaymentOption": "<p>The payment option for the order.</p>",
   343          "Order$PaymentOption": "<p>The payment option for the order.</p>"
   344        }
   345      },
   346      "PaymentTerm": {
   347        "base": null,
   348        "refs": {
   349          "CreateOrderInput$PaymentTerm": "<p>The payment terms for the order.</p>"
   350        }
   351      },
   352      "ResourceType": {
   353        "base": null,
   354        "refs": {
   355          "ConflictException$ResourceType": "<p>The type of the resource causing the conflict.</p>"
   356        }
   357      },
   358      "ServiceQuotaExceededException": {
   359        "base": "<p>You have exceeded a service quota.</p>",
   360        "refs": {
   361        }
   362      },
   363      "Site": {
   364        "base": "<p>Information about a site.</p>",
   365        "refs": {
   366          "siteListDefinition$member": null
   367        }
   368      },
   369      "SiteArn": {
   370        "base": "<p>The Amazon Resource Name (ARN) of the site.</p>",
   371        "refs": {
   372          "Outpost$SiteArn": null,
   373          "Site$SiteArn": null
   374        }
   375      },
   376      "SiteDescription": {
   377        "base": "<p>The description of the site.</p>",
   378        "refs": {
   379          "Site$Description": null
   380        }
   381      },
   382      "SiteId": {
   383        "base": "<p>The ID of the site.</p>",
   384        "refs": {
   385          "CreateOutpostInput$SiteId": null,
   386          "DeleteSiteInput$SiteId": null,
   387          "Outpost$SiteId": null,
   388          "Site$SiteId": null
   389        }
   390      },
   391      "SiteName": {
   392        "base": "<p>The name of the site.</p>",
   393        "refs": {
   394          "Site$Name": null
   395        }
   396      },
   397      "SkuCode": {
   398        "base": null,
   399        "refs": {
   400          "LineItem$CatalogItemId": "<p> The ID of the catalog item. </p>",
   401          "LineItemRequest$CatalogItemId": "<p>The ID of the catalog item.</p>"
   402        }
   403      },
   404      "Status": {
   405        "base": null,
   406        "refs": {
   407          "LineItem$Status": "<p>The status of the line item.</p>"
   408        }
   409      },
   410      "String": {
   411        "base": null,
   412        "refs": {
   413          "ConflictException$ResourceId": "<p>The ID of the resource causing the conflict.</p>"
   414        }
   415      },
   416      "TagKey": {
   417        "base": null,
   418        "refs": {
   419          "TagKeyList$member": null,
   420          "TagMap$key": null
   421        }
   422      },
   423      "TagKeyList": {
   424        "base": null,
   425        "refs": {
   426          "UntagResourceRequest$TagKeys": "<p>The tag keys.</p>"
   427        }
   428      },
   429      "TagMap": {
   430        "base": null,
   431        "refs": {
   432          "CreateOutpostInput$Tags": "<p>The tags to apply to the Outpost.</p>",
   433          "ListTagsForResourceResponse$Tags": "<p>The resource tags.</p>",
   434          "Outpost$Tags": "<p>The Outpost tags.</p>",
   435          "Site$Tags": "<p>The site tags.</p>",
   436          "TagResourceRequest$Tags": "<p>The tags to add to the resource.</p>"
   437        }
   438      },
   439      "TagResourceRequest": {
   440        "base": null,
   441        "refs": {
   442        }
   443      },
   444      "TagResourceResponse": {
   445        "base": null,
   446        "refs": {
   447        }
   448      },
   449      "TagValue": {
   450        "base": null,
   451        "refs": {
   452          "TagMap$value": null
   453        }
   454      },
   455      "Token": {
   456        "base": "<p>The pagination token.</p>",
   457        "refs": {
   458          "GetOutpostInstanceTypesInput$NextToken": null,
   459          "GetOutpostInstanceTypesOutput$NextToken": null,
   460          "ListOutpostsInput$NextToken": null,
   461          "ListOutpostsOutput$NextToken": null,
   462          "ListSitesInput$NextToken": null,
   463          "ListSitesOutput$NextToken": null
   464        }
   465      },
   466      "UntagResourceRequest": {
   467        "base": null,
   468        "refs": {
   469        }
   470      },
   471      "UntagResourceResponse": {
   472        "base": null,
   473        "refs": {
   474        }
   475      },
   476      "ValidationException": {
   477        "base": "<p>A parameter is not valid.</p>",
   478        "refs": {
   479        }
   480      },
   481      "outpostListDefinition": {
   482        "base": "<p>Information about the Outposts.</p>",
   483        "refs": {
   484          "ListOutpostsOutput$Outposts": null
   485        }
   486      },
   487      "siteListDefinition": {
   488        "base": "<p>Information about the sites.</p>",
   489        "refs": {
   490          "ListSitesOutput$Sites": null
   491        }
   492      }
   493    }
   494  }