From 806e492ece9dbe179ca819a013b6900d20bfe5a5 Mon Sep 17 00:00:00 2001 From: aws-sdk-cpp-automation Date: Mon, 11 Nov 2024 19:05:19 +0000 Subject: [PATCH] Update API model --- .../smithy/api-descriptions/cloudfront.json | 251 ++++++-- .../smithy/api-descriptions/inspector2.json | 83 ++- .../smithy/api-descriptions/lambda.json | 6 + .../smithy/api-descriptions/opensearch.json | 583 +++++++++++++++++- .../smithy/api-descriptions/outposts.json | 539 +++++++++++++++- 5 files changed, 1405 insertions(+), 57 deletions(-) diff --git a/tools/code-generation/smithy/api-descriptions/cloudfront.json b/tools/code-generation/smithy/api-descriptions/cloudfront.json index 1be0bd9361e..f63ca860bab 100644 --- a/tools/code-generation/smithy/api-descriptions/cloudfront.json +++ b/tools/code-generation/smithy/api-descriptions/cloudfront.json @@ -1,33 +1,5 @@ { "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, "shapes": { "com.amazonaws.cloudfront#AccessControlAllowHeadersList": { "type": "list", @@ -3914,6 +3886,54 @@ ], "traits": { "smithy.api#documentation": "

Creates a CloudFront function.

\n

To create a function, you provide the function code and some configuration information\n\t\t\tabout the function. The response contains an Amazon Resource Name (ARN) that uniquely\n\t\t\tidentifies the function.

\n

When you create a function, it's in the DEVELOPMENT stage. In this stage,\n\t\t\tyou can test the function with TestFunction, and update it with\n\t\t\t\tUpdateFunction.

\n

When you're ready to use your function with a CloudFront distribution, use\n\t\t\t\tPublishFunction to copy the function from the DEVELOPMENT\n\t\t\tstage to LIVE. When it's live, you can attach the function to a\n\t\t\tdistribution's cache behavior, using the function's ARN.

", + "smithy.api#examples": [ + { + "title": "To create a function", + "documentation": "Use the following command to create a function.", + "input": { + "Name": "my-function-name", + "FunctionConfig": { + "Comment": "my-function-comment", + "Runtime": "cloudfront-js-2.0", + "KeyValueStoreAssociations": { + "Quantity": 1, + "Items": [ + { + "KeyValueStoreARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889" + } + ] + } + }, + "FunctionCode": "function-code.js" + }, + "output": { + "FunctionSummary": { + "Name": "my-function-name", + "Status": "UNPUBLISHED", + "FunctionConfig": { + "Comment": "my-function-comment", + "Runtime": "cloudfront-js-2.0", + "KeyValueStoreAssociations": { + "Quantity": 1, + "Items": [ + { + "KeyValueStoreARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889" + } + ] + } + }, + "FunctionMetadata": { + "FunctionARN": "arn:aws:cloudfront::123456789012:function/my-function-name", + "Stage": "DEVELOPMENT", + "CreatedTime": "2023-11-07T19:53:50.334Z", + "LastModifiedTime": "2023-11-07T19:53:50.334Z" + } + }, + "Location": "https://cloudfront.amazonaws.com/2020-05-31/function/arn:aws:cloudfront::123456789012:function/my-function-name", + "ETag": "ETVPDKIKX0DER" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/function", @@ -4175,6 +4195,32 @@ ], "traits": { "smithy.api#documentation": "

Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource that you own.

", + "smithy.api#examples": [ + { + "title": "To create a KeyValueStore", + "documentation": "Use the following command to create a KeyValueStore.", + "input": { + "Name": "my-keyvaluestore-name", + "Comment": "my-key-valuestore-comment", + "ImportSource": { + "SourceType": "S3", + "SourceARN": "arn:aws:s3:::my-bucket/validJSON.json" + } + }, + "output": { + "KeyValueStore": { + "Name": "my-keyvaluestore-name", + "Id": "54947df8-0e9e-4471-a2f9-9af509fb5889", + "Comment": "my-key-valuestore-comment", + "ARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", + "Status": "PROVISIONING", + "LastModifiedTime": "2023-11-07T18:15:52.042Z" + }, + "ETag": "ETVPDKIKX0DER", + "Location": "https://cloudfront.amazonaws.com/2020-05-31/key-value-store/arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/key-value-store", @@ -5673,6 +5719,16 @@ ], "traits": { "smithy.api#documentation": "

Specifies the key value store to delete.

", + "smithy.api#examples": [ + { + "title": "To delete a KeyValueStore", + "documentation": "Use the following command to delete a KeyValueStore.", + "input": { + "Name": "my-keyvaluestore-name", + "IfMatch": "ETVPDKIKX0DER" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/key-value-store/{Name}", @@ -6196,6 +6252,26 @@ ], "traits": { "smithy.api#documentation": "

Specifies the key value store and its configuration.

", + "smithy.api#examples": [ + { + "title": "To describe a KeyValueStore", + "documentation": "Use the following command to describe a KeyValueStore.", + "input": { + "Name": "my-keyvaluestore-name" + }, + "output": { + "KeyValueStore": { + "Name": "my-keyvaluestore-name", + "Id": "54947df8-0e9e-4471-a2f9-9af509fb5889", + "Comment": "my-key-valuestore-comment", + "ARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", + "Status": "READY", + "LastModifiedTime": "2023-11-07T18:20:33.056Z" + }, + "ETag": "ETVPDKIKX0DER" + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/key-value-store/{Name}", @@ -8169,7 +8245,8 @@ } } ], - "minDelay": 60 + "minDelay": 60, + "maxDelay": 2100 } } } @@ -8649,7 +8726,8 @@ } } ], - "minDelay": 20 + "minDelay": 20, + "maxDelay": 600 } } } @@ -9481,7 +9559,8 @@ } } ], - "minDelay": 60 + "minDelay": 60, + "maxDelay": 1500 } } } @@ -11833,6 +11912,32 @@ ], "traits": { "smithy.api#documentation": "

Specifies the key value stores to list.

", + "smithy.api#examples": [ + { + "title": "To get a list of KeyValueStores", + "documentation": "The following command retrieves a list of KeyValueStores with READY status.", + "input": { + "Status": "READY" + }, + "output": { + "KeyValueStoreList": { + "NextMarker": "", + "MaxItems": 100, + "Quantity": 1, + "Items": [ + { + "Name": "my-keyvaluestore-name", + "Id": "54947df8-0e9e-4471-a2f9-9af509fb5889", + "Comment": "", + "ARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", + "Status": "READY", + "LastModifiedTime": "2023-11-07T18:45:21.069Z" + } + ] + } + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/key-value-store", @@ -11904,7 +12009,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the list of CloudFront origin access controls in this Amazon Web Services account.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send another\n\t\t\trequest that specifies the NextMarker value from the current response as\n\t\t\tthe Marker value in the next request.

", + "smithy.api#documentation": "

Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send another\n\t\t\trequest that specifies the NextMarker value from the current response as\n\t\t\tthe Marker value in the next request.

\n \n

If you're not using origin access controls for your Amazon Web Services account, the\n\t\t\t\t\tListOriginAccessControls operation doesn't return the\n\t\t\t\t\tItems element in the response.

\n ", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-access-control", @@ -12040,6 +12145,12 @@ "method": "GET", "uri": "/2020-05-31/public-key", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "PublicKeyList.NextMarker", + "items": "PublicKeyList.Items", + "pageSize": "MaxItems" } } }, @@ -17377,7 +17488,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration for a CloudFront distribution.

\n

The update process includes getting the current distribution configuration, updating\n\t\t\tit to make your changes, and then submitting an UpdateDistribution request\n\t\t\tto make the updates.

\n

\n To update a web distribution using the CloudFront\n\t\t\tAPI\n

\n
    \n
  1. \n

    Use GetDistributionConfig to get the current configuration,\n\t\t\t\t\tincluding the version identifier (ETag).

    \n
    2. \n
  2. \n

    Update the distribution configuration that was returned in the response. Note\n\t\t\t\t\tthe following important requirements and restrictions:

    \n
      \n
    • \n

      You must rename the ETag field to IfMatch,\n\t\t\t\t\t\t\tleaving the value unchanged. (Set the value of IfMatch to\n\t\t\t\t\t\t\tthe value of ETag, then remove the ETag\n\t\t\t\t\t\t\tfield.)

      \n
      • \n
    • \n

      You can't change the value of CallerReference.

      \n
      • \n
    \n
    3. \n
  3. \n

    Submit an UpdateDistribution request, providing the distribution\n\t\t\t\t\tconfiguration. The new configuration replaces the existing configuration. The\n\t\t\t\t\tvalues that you specify in an UpdateDistribution request are not\n\t\t\t\t\tmerged into your existing configuration. Make sure to include all fields: the\n\t\t\t\t\tones that you modified and also the ones that you didn't.

    \n
    4. \n
", + "smithy.api#documentation": "

Updates the configuration for a CloudFront distribution.

\n

The update process includes getting the current distribution configuration, updating\n\t\t\tit to make your changes, and then submitting an UpdateDistribution request\n\t\t\tto make the updates.

\n

\n To update a web distribution using the CloudFront\n\t\t\tAPI\n

\n
    \n
  1. \n

    Use GetDistributionConfig to get the current configuration,\n\t\t\t\t\tincluding the version identifier (ETag).

    \n
    2. \n
  2. \n

    Update the distribution configuration that was returned in the response. Note\n\t\t\t\t\tthe following important requirements and restrictions:

    \n
      \n
    • \n

      You must copy the ETag field value from the response. (You'll use it for the IfMatch parameter in your request.) Then, remove the ETag\n\t\t\t\t\t\t\tfield from the distribution configuration.

      \n
      • \n
    • \n

      You can't change the value of CallerReference.

      \n
      • \n
    \n
    3. \n
  3. \n

    Submit an UpdateDistribution request, providing the updated distribution\n\t\t\t\t\tconfiguration. The new configuration replaces the existing configuration. The\n\t\t\t\t\tvalues that you specify in an UpdateDistribution request are not\n\t\t\t\t\tmerged into your existing configuration. Make sure to include all fields: the\n\t\t\t\t\tones that you modified and also the ones that you didn't.

    \n
    4. \n
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/distribution/{Id}/config", @@ -17664,7 +17775,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current versions (ETag values) of both primary and staging distributions.\n\t\t\tProvide these in the following format:

\n

\n , \n

", + "smithy.api#documentation": "

The current versions (ETag values) of both primary and staging distributions.\n\t\t\tProvide these in the following format:

\n

\n <primary ETag>, <staging ETag>\n

", "smithy.api#httpHeader": "If-Match" } } @@ -17939,6 +18050,54 @@ ], "traits": { "smithy.api#documentation": "

Updates a CloudFront function.

\n

You can update a function's code or the comment that describes the function. You\n\t\t\tcannot update a function's name.

\n

To update a function, you provide the function's name and version (ETag\n\t\t\tvalue) along with the updated function code. To get the name and version, you can use\n\t\t\t\tListFunctions and DescribeFunction.

", + "smithy.api#examples": [ + { + "title": "To update a function", + "documentation": "Use the following command to update a function.", + "input": { + "Name": "my-function-name", + "FunctionConfig": { + "Comment": "my-changed-comment", + "Runtime": "cloudfront-js-2.0", + "KeyValueStoreAssociations": { + "Quantity": 1, + "Items": [ + { + "KeyValueStoreARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889" + } + ] + } + }, + "FunctionCode": "function-code-changed.js", + "IfMatch": "ETVPDKIKX0DER" + }, + "output": { + "FunctionSummary": { + "Name": "my-function-name", + "Status": "UNPUBLISHED", + "FunctionConfig": { + "Comment": "my-changed-comment", + "Runtime": "cloudfront-js-2.0", + "KeyValueStoreAssociations": { + "Quantity": 1, + "Items": [ + { + "KeyValueStoreARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889" + } + ] + } + }, + "FunctionMetadata": { + "FunctionARN": "arn:aws:cloudfront::123456789012:function/my-function-name", + "Stage": "DEVELOPMENT", + "CreatedTime": "2023-11-07T19:53:50.334Z", + "LastModifiedTime": "2023-11-07T20:01:37.174Z" + } + }, + "ETag": "E3UN6WX5RRO2AG" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/function/{Name}", @@ -18127,6 +18286,28 @@ ], "traits": { "smithy.api#documentation": "

Specifies the key value store to update.

", + "smithy.api#examples": [ + { + "title": "To update a KeyValueStore", + "documentation": "Use the following command to update a KeyValueStore.", + "input": { + "Name": "my-keyvaluestore-name", + "Comment": "my-changed-comment", + "IfMatch": "ETVPDKIKX0DER" + }, + "output": { + "KeyValueStore": { + "Name": "my-keyvaluestore-name", + "Id": "54947df8-0e9e-4471-a2f9-9af509fb5889", + "Comment": "my-changed-comment", + "ARN": "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", + "Status": "READY", + "LastModifiedTime": "2023-11-07T18:45:21.069Z" + }, + "ETag": "E3UN6WX5RRO2AG" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/key-value-store/{Name}", @@ -18911,4 +19092,4 @@ "type": "timestamp" } } -} +} \ No newline at end of file diff --git a/tools/code-generation/smithy/api-descriptions/inspector2.json b/tools/code-generation/smithy/api-descriptions/inspector2.json index 97f840031f0..41a02b0b1d7 100644 --- a/tools/code-generation/smithy/api-descriptions/inspector2.json +++ b/tools/code-generation/smithy/api-descriptions/inspector2.json @@ -12,7 +12,7 @@ } }, "traits": { - "smithy.api#documentation": "

You do not have sufficient access to perform this action.

\n

\n For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.\n

", + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -3562,7 +3562,7 @@ "scanMode": { "target": "com.amazonaws.inspector2#CoverageStringFilterList", "traits": { - "smithy.api#documentation": "

The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED and EC2_HYBRID.

" + "smithy.api#documentation": "

The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED and EC2_AGENTLESS.

" } }, "imagePulledAt": { @@ -4130,6 +4130,7 @@ "s3Destination": { "target": "com.amazonaws.inspector2#Destination", "traits": { + "smithy.api#documentation": "

Contains details of the Amazon S3 bucket and KMS key used to export findings.

", "smithy.api#required": {} } } @@ -6566,7 +6567,10 @@ } }, "cisaData": { - "target": "com.amazonaws.inspector2#CisaData" + "target": "com.amazonaws.inspector2#CisaData", + "traits": { + "smithy.api#documentation": "

The Cybersecurity and Infrastructure Security Agency (CISA) details for a specific vulnerability.

" + } }, "riskScore": { "target": "com.amazonaws.inspector2#RiskScore", @@ -6593,7 +6597,10 @@ } }, "exploitObserved": { - "target": "com.amazonaws.inspector2#ExploitObserved" + "target": "com.amazonaws.inspector2#ExploitObserved", + "traits": { + "smithy.api#documentation": "

Contains information on when this exploit was observed.

" + } }, "referenceUrls": { "target": "com.amazonaws.inspector2#VulnerabilityReferenceUrls", @@ -7731,7 +7738,10 @@ } }, "s3Destination": { - "target": "com.amazonaws.inspector2#Destination" + "target": "com.amazonaws.inspector2#Destination", + "traits": { + "smithy.api#documentation": "

Contains details of the Amazon S3 bucket and KMS key used to export findings

" + } }, "filterCriteria": { "target": "com.amazonaws.inspector2#ResourceFilterCriteria", @@ -9104,7 +9114,10 @@ } }, "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts" + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

An object that contains the counts of aggregated finding per severity.

" + } }, "lastModifiedAt": { "target": "com.amazonaws.inspector2#DateTimeTimestamp", @@ -9238,7 +9251,10 @@ } }, "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts" + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

An object that contains the counts of aggregated finding per severity.

" + } } }, "traits": { @@ -10116,7 +10132,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists coverage details for you environment.

", + "smithy.api#documentation": "

Lists coverage details for your environment.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -11359,7 +11375,16 @@ } }, "sourceLambdaLayerArn": { - "target": "com.amazonaws.inspector2#StringFilter" + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "

An object that describes the details of a string filter.

" + } + }, + "filePath": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "

An object that contains details on the package file path to filter on.

" + } } }, "traits": { @@ -11449,6 +11474,10 @@ { "value": "GEMSPEC", "name": "GEMSPEC" + }, + { + "value": "DOTNET_CORE", + "name": "DOTNET_CORE" } ] } @@ -12380,10 +12409,16 @@ } }, "lambda": { - "target": "com.amazonaws.inspector2#State" + "target": "com.amazonaws.inspector2#State", + "traits": { + "smithy.api#documentation": "

An object that described the state of Amazon Inspector scans for an account.

" + } }, "lambdaCode": { - "target": "com.amazonaws.inspector2#State" + "target": "com.amazonaws.inspector2#State", + "traits": { + "smithy.api#documentation": "

An object that described the state of Amazon Inspector scans for an account.

" + } } }, "traits": { @@ -12592,6 +12627,30 @@ { "value": "PYTHON_3_10", "name": "PYTHON_3_10" + }, + { + "value": "PYTHON_3_11", + "name": "PYTHON_3_11" + }, + { + "value": "DOTNETCORE_3_1", + "name": "DOTNETCORE_3_1" + }, + { + "value": "DOTNET_6", + "name": "DOTNET_6" + }, + { + "value": "DOTNET_7", + "name": "DOTNET_7" + }, + { + "value": "RUBY_2_7", + "name": "RUBY_2_7" + }, + { + "value": "RUBY_3_2", + "name": "RUBY_3_2" } ] } @@ -13630,7 +13689,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Stops a CIS session. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.\n

", + "smithy.api#documentation": "

\n Stops a CIS session. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to stop a CIS scan session for the scan ID supplied by the service.\n

", "smithy.api#examples": [ { "title": "Sample StopCisSession Call", diff --git a/tools/code-generation/smithy/api-descriptions/lambda.json b/tools/code-generation/smithy/api-descriptions/lambda.json index 83fbfb99515..ec739162d52 100644 --- a/tools/code-generation/smithy/api-descriptions/lambda.json +++ b/tools/code-generation/smithy/api-descriptions/lambda.json @@ -11256,6 +11256,12 @@ "traits": { "smithy.api#enumValue": "java21" } + }, + "python313": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.13" + } } } }, diff --git a/tools/code-generation/smithy/api-descriptions/opensearch.json b/tools/code-generation/smithy/api-descriptions/opensearch.json index 68a2361902f..d9e59bd5367 100644 --- a/tools/code-generation/smithy/api-descriptions/opensearch.json +++ b/tools/code-generation/smithy/api-descriptions/opensearch.json @@ -646,6 +646,9 @@ { "target": "com.amazonaws.opensearch#AssociatePackage" }, + { + "target": "com.amazonaws.opensearch#AssociatePackages" + }, { "target": "com.amazonaws.opensearch#AuthorizeVpcEndpointAccess" }, @@ -739,6 +742,9 @@ { "target": "com.amazonaws.opensearch#DissociatePackage" }, + { + "target": "com.amazonaws.opensearch#DissociatePackages" + }, { "target": "com.amazonaws.opensearch#GetApplication" }, @@ -829,6 +835,9 @@ { "target": "com.amazonaws.opensearch#UpdatePackage" }, + { + "target": "com.amazonaws.opensearch#UpdatePackageScope" + }, { "target": "com.amazonaws.opensearch#UpdateScheduledAction" }, @@ -2142,6 +2151,18 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "PrerequisitePackageIDList": { + "target": "com.amazonaws.opensearch#PackageIDList", + "traits": { + "smithy.api#documentation": "

A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

" + } + }, + "AssociationConfiguration": { + "target": "com.amazonaws.opensearch#PackageAssociationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for associating a package with an Amazon OpenSearch Service domain.

" + } } }, "traits": { @@ -2164,6 +2185,78 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#AssociatePackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#AssociatePackagesRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#AssociatePackagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#ConflictException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-01-01/packages/associateMultiple", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#AssociatePackagesRequest": { + "type": "structure", + "members": { + "PackageList": { + "target": "com.amazonaws.opensearch#PackageDetailsForAssociationList", + "traits": { + "smithy.api#documentation": "

A list of packages and their prerequisites to be associated with a domain.

", + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#AssociatePackagesResponse": { + "type": "structure", + "members": { + "DomainPackageDetailsList": { + "target": "com.amazonaws.opensearch#DomainPackageDetailsList", + "traits": { + "smithy.api#documentation": "

List of information about packages that are associated with a domain.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#AuthorizeVpcEndpointAccess": { "type": "operation", "input": { @@ -3918,6 +4011,30 @@ "smithy.api#documentation": "

The Amazon S3 location from which to import the package.

", "smithy.api#required": {} } + }, + "PackageConfiguration": { + "target": "com.amazonaws.opensearch#PackageConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration parameters for the package being created.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.opensearch#EngineVersion", + "traits": { + "smithy.api#documentation": "

The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN\n

" + } + }, + "PackageVendingOptions": { + "target": "com.amazonaws.opensearch#PackageVendingOptions", + "traits": { + "smithy.api#documentation": "

The vending options for the package being created. They determine if the package can be vended to other users.

" + } + }, + "PackageEncryptionOptions": { + "target": "com.amazonaws.opensearch#PackageEncryptionOptions", + "traits": { + "smithy.api#documentation": "

The encryption parameters for the package being created.

" + } } }, "traits": { @@ -5644,6 +5761,12 @@ "traits": { "smithy.api#enumValue": "EngineVersion" } + }, + "PackageOwner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PackageOwner" + } } } }, @@ -6056,6 +6179,78 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#DissociatePackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#DissociatePackagesRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#DissociatePackagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#ConflictException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Dissociates multiple packages from a domain simulatneously.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-01-01/packages/dissociateMultiple", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#DissociatePackagesRequest": { + "type": "structure", + "members": { + "PackageList": { + "target": "com.amazonaws.opensearch#PackageIDList", + "traits": { + "smithy.api#documentation": "

A list of package IDs to be dissociated from a domain.

", + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#DissociatePackagesResponse": { + "type": "structure", + "members": { + "DomainPackageDetailsList": { + "target": "com.amazonaws.opensearch#DomainPackageDetailsList", + "traits": { + "smithy.api#documentation": "

A list of package details for the packages that were dissociated from the domain.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#DomainArn": { "type": "string", "traits": { @@ -6544,6 +6739,12 @@ "smithy.api#documentation": "

The current version of the package.

" } }, + "PrerequisitePackageIDList": { + "target": "com.amazonaws.opensearch#PackageIDList", + "traits": { + "smithy.api#documentation": "

A list of package IDs that must be associated with the domain before or with the package can be associated.

" + } + }, "ReferencePath": { "target": "com.amazonaws.opensearch#ReferencePath", "traits": { @@ -6555,6 +6756,12 @@ "traits": { "smithy.api#documentation": "

Additional information if the package is in an error state. Null otherwise.

" } + }, + "AssociationConfiguration": { + "target": "com.amazonaws.opensearch#PackageAssociationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for associating a package with an Amazon OpenSearch Service domain.

" + } } }, "traits": { @@ -8514,6 +8721,27 @@ "smithy.api#documentation": "

Describes the JWT options configured for the domain.

" } }, + "com.amazonaws.opensearch#KeyStoreAccessOption": { + "type": "structure", + "members": { + "KeyAccessRoleArn": { + "target": "com.amazonaws.opensearch#RoleArn", + "traits": { + "smithy.api#documentation": "

Role ARN to access the KeyStore Key

" + } + }, + "KeyStoreAccessEnabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

This indicates whether Key Store access is enabled

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration parameters to enable access to the key store required by the package.

" + } + }, "com.amazonaws.opensearch#KmsKeyId": { "type": "string", "traits": { @@ -8527,6 +8755,16 @@ "com.amazonaws.opensearch#LastUpdated": { "type": "timestamp" }, + "com.amazonaws.opensearch#LicenseFilepath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(?!.*\\/\\.{2,})(?!.*\\.\\.)[a-zA-Z0-9_.-]+(?:\\/[a-zA-Z0-9_.-]+)*$" + } + }, "com.amazonaws.opensearch#LimitExceededException": { "type": "structure", "members": { @@ -11158,6 +11396,54 @@ "smithy.api#pattern": "^[0-9]+$" } }, + "com.amazonaws.opensearch#PackageAssociationConfiguration": { + "type": "structure", + "members": { + "KeyStoreAccessOption": { + "target": "com.amazonaws.opensearch#KeyStoreAccessOption", + "traits": { + "smithy.api#documentation": "

The configuration parameters to enable accessing the key store required by the package.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for associating a package with a domain.

" + } + }, + "com.amazonaws.opensearch#PackageConfiguration": { + "type": "structure", + "members": { + "LicenseRequirement": { + "target": "com.amazonaws.opensearch#RequirementLevel", + "traits": { + "smithy.api#documentation": "

The license requirements for the package.

", + "smithy.api#required": {} + } + }, + "LicenseFilepath": { + "target": "com.amazonaws.opensearch#LicenseFilepath", + "traits": { + "smithy.api#documentation": "

The relative file path for the license associated with the package.

" + } + }, + "ConfigurationRequirement": { + "target": "com.amazonaws.opensearch#RequirementLevel", + "traits": { + "smithy.api#documentation": "

The configuration requirements for the package.

", + "smithy.api#required": {} + } + }, + "RequiresRestartForConfigurationUpdate": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration parameters for a package.

" + } + }, "com.amazonaws.opensearch#PackageDescription": { "type": "string", "traits": { @@ -11235,22 +11521,112 @@ "traits": { "smithy.api#documentation": "

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

" } + }, + "AvailablePackageConfiguration": { + "target": "com.amazonaws.opensearch#PackageConfiguration", + "traits": { + "smithy.api#documentation": "

This represents the available configuration parameters for the package.

" + } + }, + "AllowListedUserList": { + "target": "com.amazonaws.opensearch#PackageUserList", + "traits": { + "smithy.api#documentation": "

A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

" + } + }, + "PackageOwner": { + "target": "com.amazonaws.opensearch#PackageOwner", + "traits": { + "smithy.api#documentation": "

The owner of the package who is allowed to create/update a package and add users to the package scope.

" + } + }, + "PackageVendingOptions": { + "target": "com.amazonaws.opensearch#PackageVendingOptions", + "traits": { + "smithy.api#documentation": "

Package Vending Options for a package.

" + } + }, + "PackageEncryptionOptions": { + "target": "com.amazonaws.opensearch#PackageEncryptionOptions", + "traits": { + "smithy.api#documentation": "

Package Encryption Options for a package.

" + } } }, "traits": { "smithy.api#documentation": "

Basic information about a package.

" } }, + "com.amazonaws.opensearch#PackageDetailsForAssociation": { + "type": "structure", + "members": { + "PackageID": { + "target": "com.amazonaws.opensearch#PackageID", + "traits": { + "smithy.api#documentation": "

Internal ID of the package that you want to associate with a domain.

", + "smithy.api#required": {} + } + }, + "PrerequisitePackageIDList": { + "target": "com.amazonaws.opensearch#PackageIDList", + "traits": { + "smithy.api#documentation": "

List of package IDs that must be associated with the domain with or before the package can be associated.

" + } + }, + "AssociationConfiguration": { + "target": "com.amazonaws.opensearch#PackageAssociationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration parameters for associating the package with a domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of a package that is associated with a domain.

" + } + }, + "com.amazonaws.opensearch#PackageDetailsForAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#PackageDetailsForAssociation" + } + }, "com.amazonaws.opensearch#PackageDetailsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#PackageDetails" } }, + "com.amazonaws.opensearch#PackageEncryptionOptions": { + "type": "structure", + "members": { + "KmsKeyIdentifier": { + "target": "com.amazonaws.opensearch#KmsKeyId", + "traits": { + "smithy.api#documentation": "

KMS key ID for encrypting the package.

" + } + }, + "EncryptionEnabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

This indicates whether encryption is enabled for the package.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Encryption options for a package.

" + } + }, "com.amazonaws.opensearch#PackageID": { "type": "string", "traits": { - "smithy.api#pattern": "^([FG][0-9]+)$" + "smithy.api#pattern": "^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$" + } + }, + "com.amazonaws.opensearch#PackageIDList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#PackageID" } }, "com.amazonaws.opensearch#PackageName": { @@ -11263,6 +11639,38 @@ "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" } }, + "com.amazonaws.opensearch#PackageOwner": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.opensearch#PackageScopeOperationEnum": { + "type": "enum", + "members": { + "ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD" + } + }, + "OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDE" + } + }, + "REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE" + } + } + } + }, "com.amazonaws.opensearch#PackageSource": { "type": "structure", "members": { @@ -11350,9 +11758,52 @@ "traits": { "smithy.api#enumValue": "ZIP-PLUGIN" } + }, + "PACKAGE_LICENSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PACKAGE-LICENSE" + } + }, + "PACKAGE_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PACKAGE-CONFIG" + } } } }, + "com.amazonaws.opensearch#PackageUser": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$|^GLOBAL$" + } + }, + "com.amazonaws.opensearch#PackageUserList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#PackageUser" + } + }, + "com.amazonaws.opensearch#PackageVendingOptions": { + "type": "structure", + "members": { + "VendingEnabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

This indicates whether vending is enabled for the package to determine if package can be used by other users.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The vending options for a package to determine if the package can be used by other users.\n

" + } + }, "com.amazonaws.opensearch#PackageVersion": { "type": "string" }, @@ -11382,6 +11833,12 @@ "traits": { "smithy.api#documentation": "

Additional information about plugin properties if the package is a ZIP-PLUGIN package.

" } + }, + "PackageConfiguration": { + "target": "com.amazonaws.opensearch#PackageConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details for a specific version of a package.

" + } } }, "traits": { @@ -11771,6 +12228,29 @@ "smithy.api#pattern": "^([\\s\\S]*)$" } }, + "com.amazonaws.opensearch#RequirementLevel": { + "type": "enum", + "members": { + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRED" + } + }, + "OPTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIONAL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.opensearch#ReservationToken": { "type": "string", "traits": { @@ -13545,6 +14025,18 @@ "traits": { "smithy.api#documentation": "

Commit message for the updated file, which is shown as part of\n GetPackageVersionHistoryResponse.

" } + }, + "PackageConfiguration": { + "target": "com.amazonaws.opensearch#PackageConfiguration", + "traits": { + "smithy.api#documentation": "

The updated configuration details for a package.

" + } + }, + "PackageEncryptionOptions": { + "target": "com.amazonaws.opensearch#PackageEncryptionOptions", + "traits": { + "smithy.api#documentation": "

Encryption options for a package.

" + } } }, "traits": { @@ -13567,6 +14059,95 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#UpdatePackageScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#UpdatePackageScopeRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#UpdatePackageScopeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the scope of a package. Scope of the package defines users who can view and associate a package.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-01-01/packages/updateScope", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#UpdatePackageScopeRequest": { + "type": "structure", + "members": { + "PackageID": { + "target": "com.amazonaws.opensearch#PackageID", + "traits": { + "smithy.api#documentation": "

ID of the package whose scope is being updated.

", + "smithy.api#required": {} + } + }, + "Operation": { + "target": "com.amazonaws.opensearch#PackageScopeOperationEnum", + "traits": { + "smithy.api#documentation": "

The operation to perform on the package scope (e.g., add/remove/override users).

", + "smithy.api#required": {} + } + }, + "PackageUserList": { + "target": "com.amazonaws.opensearch#PackageUserList", + "traits": { + "smithy.api#documentation": "

List of users to be added or removed from the package scope.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#UpdatePackageScopeResponse": { + "type": "structure", + "members": { + "PackageID": { + "target": "com.amazonaws.opensearch#PackageID", + "traits": { + "smithy.api#documentation": "

ID of the package whose scope was updated.

" + } + }, + "Operation": { + "target": "com.amazonaws.opensearch#PackageScopeOperationEnum", + "traits": { + "smithy.api#documentation": "

The operation that was performed on the package scope.

" + } + }, + "PackageUserList": { + "target": "com.amazonaws.opensearch#PackageUserList", + "traits": { + "smithy.api#documentation": "

List of users who have access to the package after the scope update.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#UpdateScheduledAction": { "type": "operation", "input": { diff --git a/tools/code-generation/smithy/api-descriptions/outposts.json b/tools/code-generation/smithy/api-descriptions/outposts.json index 50c92efa94f..969a1dcc393 100644 --- a/tools/code-generation/smithy/api-descriptions/outposts.json +++ b/tools/code-generation/smithy/api-descriptions/outposts.json @@ -29,6 +29,53 @@ ] }, "shapes": { + "com.amazonaws.outposts#AWSServiceName": { + "type": "enum", + "members": { + "AWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS" + } + }, + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" + } + }, + "ELASTICACHE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELASTICACHE" + } + }, + "ELB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELB" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS" + } + }, + "ROUTE53": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUTE53" + } + } + } + }, + "com.amazonaws.outposts#AWSServiceNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#AWSServiceName" + } + }, "com.amazonaws.outposts#AccessDeniedException": { "type": "structure", "members": { @@ -53,6 +100,12 @@ "smithy.api#pattern": "^\\d{12}$" } }, + "com.amazonaws.outposts#AccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#AccountId" + } + }, "com.amazonaws.outposts#Address": { "type": "structure", "members": { @@ -199,6 +252,12 @@ "smithy.api#pattern": "^(\\w+)$" } }, + "com.amazonaws.outposts#AssetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#AssetId" + } + }, "com.amazonaws.outposts#AssetInfo": { "type": "structure", "members": { @@ -237,6 +296,76 @@ "smithy.api#documentation": "

Information about hardware assets.

" } }, + "com.amazonaws.outposts#AssetInstance": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.outposts#InstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.outposts#OutpostInstanceType", + "traits": { + "smithy.api#documentation": "

The type of instance.

" + } + }, + "AssetId": { + "target": "com.amazonaws.outposts#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the asset.

" + } + }, + "AccountId": { + "target": "com.amazonaws.outposts#AccountId" + }, + "AwsServiceName": { + "target": "com.amazonaws.outposts#AWSServiceName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service name of the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon EC2 instance.

" + } + }, + "com.amazonaws.outposts#AssetInstanceCapacityList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#AssetInstanceTypeCapacity" + } + }, + "com.amazonaws.outposts#AssetInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#AssetInstance" + } + }, + "com.amazonaws.outposts#AssetInstanceTypeCapacity": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.outposts#InstanceTypeName", + "traits": { + "smithy.api#documentation": "

The type of instance.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.outposts#InstanceTypeCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of each instance type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The capacity for each instance type.

" + } + }, "com.amazonaws.outposts#AssetListDefinition": { "type": "list", "member": { @@ -337,6 +466,35 @@ } } }, + "com.amazonaws.outposts#BlockingInstance": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.outposts#InstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the blocking instance.

" + } + }, + "AccountId": { + "target": "com.amazonaws.outposts#AccountId" + }, + "AwsServiceName": { + "target": "com.amazonaws.outposts#AWSServiceName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service name that owns the specified blocking instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A running Amazon EC2 instance that can be stopped to free up capacity needed to run the\n capacity task.

" + } + }, + "com.amazonaws.outposts#BlockingInstancesList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#BlockingInstance" + } + }, "com.amazonaws.outposts#CIDR": { "type": "string", "traits": { @@ -504,6 +662,30 @@ "traits": { "smithy.api#enumValue": "UNSUPPORTED_CAPACITY_CONFIGURATION" } + }, + "UNEXPECTED_ASSET_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNEXPECTED_ASSET_STATE" + } + }, + "BLOCKING_INSTANCES_NOT_EVACUATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKING_INSTANCES_NOT_EVACUATED" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_NOT_FOUND" + } } } }, @@ -550,6 +732,18 @@ "smithy.api#enumValue": "COMPLETED" } }, + "WAITING_FOR_EVACUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAITING_FOR_EVACUATION" + } + }, + "CANCELLATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLATION_IN_PROGRESS" + } + }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { @@ -784,6 +978,18 @@ "traits": { "smithy.api#documentation": "

A list of the names of instance families that are currently associated with a given\n asset.

" } + }, + "InstanceTypeCapacities": { + "target": "com.amazonaws.outposts#AssetInstanceCapacityList", + "traits": { + "smithy.api#documentation": "

The instance type capacities configured for this asset. This can be changed through a\n capacity task.

" + } + }, + "MaxVcpus": { + "target": "com.amazonaws.outposts#VCPUCount", + "traits": { + "smithy.api#documentation": "

The maximum number of vCPUs possible for the specified asset.

" + } } }, "traits": { @@ -1470,6 +1676,12 @@ "smithy.api#documentation": "

List of instance pools requested in the capacity task.

" } }, + "InstancesToExclude": { + "target": "com.amazonaws.outposts#InstancesToExclude", + "traits": { + "smithy.api#documentation": "

Instances that the user specified they cannot stop in order to free up the capacity needed\n to run the capacity task.

" + } + }, "DryRun": { "target": "com.amazonaws.outposts#DryRun", "traits": { @@ -1506,6 +1718,12 @@ "traits": { "smithy.api#documentation": "

The date the capacity task was last modified.

" } + }, + "TaskActionOnBlockingInstances": { + "target": "com.amazonaws.outposts#TaskActionOnBlockingInstances", + "traits": { + "smithy.api#documentation": "

User-specified option in case an instance is blocking the capacity task from running.\n Shows one of the following options:

\n " + } } }, "traits": { @@ -1861,7 +2079,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the instance types that an\n Outpost can support in InstanceTypeCapacity. This will generally include instance types that\n are not currently configured and therefore cannot be launched with the current Outpost\n capacity configuration.

", + "smithy.api#documentation": "

Gets the instance types that an Outpost can support in InstanceTypeCapacity.\n This will generally include instance types that are not currently configured and therefore\n cannot be launched with the current Outpost capacity configuration.

", "smithy.api#http": { "method": "GET", "uri": "/outposts/{OutpostIdentifier}/supportedInstanceTypes", @@ -1890,8 +2108,7 @@ "target": "com.amazonaws.outposts#OrderId", "traits": { "smithy.api#documentation": "

The ID for the Amazon Web Services Outposts order.

", - "smithy.api#httpQuery": "OrderId", - "smithy.api#required": {} + "smithy.api#httpQuery": "OrderId" } }, "MaxResults": { @@ -2096,6 +2313,22 @@ "smithy.api#pattern": "^(?:.{1,200}/)?(?:[a-z0-9-_A-Z])+$" } }, + "com.amazonaws.outposts#InstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 32 + }, + "smithy.api#pattern": "^i-[0-9a-z]+$" + } + }, + "com.amazonaws.outposts#InstanceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#InstanceId" + } + }, "com.amazonaws.outposts#InstanceType": { "type": "string", "traits": { @@ -2171,6 +2404,32 @@ "smithy.api#pattern": "^[a-z0-9\\-]+\\.[a-z0-9\\-]+$" } }, + "com.amazonaws.outposts#InstancesToExclude": { + "type": "structure", + "members": { + "Instances": { + "target": "com.amazonaws.outposts#InstanceIdList", + "traits": { + "smithy.api#documentation": "

List of user-specified instances that must not be stopped.

" + } + }, + "AccountIds": { + "target": "com.amazonaws.outposts#AccountIdList", + "traits": { + "smithy.api#documentation": "

IDs of the accounts that own each instance that must not be stopped.

" + } + }, + "Services": { + "target": "com.amazonaws.outposts#AWSServiceNameList", + "traits": { + "smithy.api#documentation": "

Names of the services that own each instance that must not be stopped in order to free up\n the capacity needed to run the capacity task.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

User-specified instances that must not be stopped. These instances will not appear in the\n list of instances that Amazon Web Services recommends to stop in order to free up capacity.

" + } + }, "com.amazonaws.outposts#InternalServerException": { "type": "structure", "members": { @@ -2409,6 +2668,116 @@ "target": "com.amazonaws.outposts#LineItemQuantity" } }, + "com.amazonaws.outposts#ListAssetInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#ListAssetInstancesInput" + }, + "output": { + "target": "com.amazonaws.outposts#ListAssetInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost.\n Does not include Amazon EBS or Amazon S3 instances.

", + "smithy.api#http": { + "method": "GET", + "uri": "/outposts/{OutpostIdentifier}/assetInstances", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssetInstances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.outposts#ListAssetInstancesInput": { + "type": "structure", + "members": { + "OutpostIdentifier": { + "target": "com.amazonaws.outposts#OutpostIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the Outpost.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssetIdFilter": { + "target": "com.amazonaws.outposts#AssetIdList", + "traits": { + "smithy.api#documentation": "

Filters the results by asset ID.

", + "smithy.api#httpQuery": "AssetIdFilter" + } + }, + "InstanceTypeFilter": { + "target": "com.amazonaws.outposts#OutpostInstanceTypeList", + "traits": { + "smithy.api#documentation": "

Filters the results by instance ID.

", + "smithy.api#httpQuery": "InstanceTypeFilter" + } + }, + "AccountIdFilter": { + "target": "com.amazonaws.outposts#AccountIdList", + "traits": { + "smithy.api#documentation": "

Filters the results by account ID.

", + "smithy.api#httpQuery": "AccountIdFilter" + } + }, + "AwsServiceFilter": { + "target": "com.amazonaws.outposts#AWSServiceNameList", + "traits": { + "smithy.api#documentation": "

Filters the results by Amazon Web Services service.

", + "smithy.api#httpQuery": "AwsServiceFilter" + } + }, + "MaxResults": { + "target": "com.amazonaws.outposts#MaxResults1000", + "traits": { + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.outposts#ListAssetInstancesOutput": { + "type": "structure", + "members": { + "AssetInstances": { + "target": "com.amazonaws.outposts#AssetInstanceList", + "traits": { + "smithy.api#documentation": "

List of instances owned by all accounts on the Outpost. Does not include Amazon EBS or Amazon S3\n instances.

" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.outposts#ListAssets": { "type": "operation", "input": { @@ -2505,6 +2874,96 @@ "smithy.api#output": {} } }, + "com.amazonaws.outposts#ListBlockingInstancesForCapacityTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#ListBlockingInstancesForCapacityTaskInput" + }, + "output": { + "target": "com.amazonaws.outposts#ListBlockingInstancesForCapacityTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 instances running on the Outpost and belonging to the account that\n initiated the capacity task. Use this list to specify the instances you cannot stop to free up\n capacity to run the capacity task.

", + "smithy.api#http": { + "method": "GET", + "uri": "/outposts/{OutpostIdentifier}/capacity/{CapacityTaskId}/blockingInstances", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "BlockingInstances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.outposts#ListBlockingInstancesForCapacityTaskInput": { + "type": "structure", + "members": { + "OutpostIdentifier": { + "target": "com.amazonaws.outposts#OutpostIdentifier", + "traits": { + "smithy.api#documentation": "

The ID or ARN of the Outpost associated with the specified capacity task.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CapacityTaskId": { + "target": "com.amazonaws.outposts#CapacityTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the capacity task.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.outposts#MaxResults1000", + "traits": { + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.outposts#ListBlockingInstancesForCapacityTaskOutput": { + "type": "structure", + "members": { + "BlockingInstances": { + "target": "com.amazonaws.outposts#BlockingInstancesList", + "traits": { + "smithy.api#documentation": "

A list of all running Amazon EC2 instances on the Outpost. Stopping one or more of these\n instances can free up the capacity needed to run the capacity task.

" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.outposts#ListCapacityTasks": { "type": "operation", "input": { @@ -2567,7 +3026,7 @@ "CapacityTaskStatusFilter": { "target": "com.amazonaws.outposts#CapacityTaskStatusList", "traits": { - "smithy.api#documentation": "

A list of statuses. For example,\n REQUESTED or WAITING_FOR_EVACUATION.

", + "smithy.api#documentation": "

A list of statuses. For example, REQUESTED or\n WAITING_FOR_EVACUATION.

", "smithy.api#httpQuery": "CapacityTaskStatusFilter" } } @@ -3200,7 +3659,7 @@ "Status": { "target": "com.amazonaws.outposts#OrderStatus", "traits": { - "smithy.api#documentation": "

The status of the order.

\n \n \n

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

\n " + "smithy.api#documentation": "

The status of the order.

\n \n \n

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

\n " } }, "LineItems": { @@ -3503,6 +3962,22 @@ "smithy.api#pattern": "^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/)?op-[a-f0-9]{17}$" } }, + "com.amazonaws.outposts#OutpostInstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 30 + }, + "smithy.api#pattern": "^[a-z0-9\\-\\.]+$" + } + }, + "com.amazonaws.outposts#OutpostInstanceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#OutpostInstanceType" + } + }, "com.amazonaws.outposts#OutpostName": { "type": "string", "traits": { @@ -3566,9 +4041,15 @@ { "target": "com.amazonaws.outposts#GetSiteAddress" }, + { + "target": "com.amazonaws.outposts#ListAssetInstances" + }, { "target": "com.amazonaws.outposts#ListAssets" }, + { + "target": "com.amazonaws.outposts#ListBlockingInstancesForCapacityTask" + }, { "target": "com.amazonaws.outposts#ListCapacityTasks" }, @@ -5106,7 +5587,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the specified capacity task. You can have one active capacity task for an order.

", + "smithy.api#documentation": "

Starts the specified capacity task. You can have one active capacity task per order or Outpost.

", "smithy.api#http": { "method": "POST", "uri": "/outposts/{OutpostIdentifier}/capacity", @@ -5128,8 +5609,7 @@ "OrderId": { "target": "com.amazonaws.outposts#OrderId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services Outposts order associated with the specified capacity task.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the Amazon Web Services Outposts order associated with the specified capacity task.

" } }, "InstancePools": { @@ -5139,11 +5619,23 @@ "smithy.api#required": {} } }, + "InstancesToExclude": { + "target": "com.amazonaws.outposts#InstancesToExclude", + "traits": { + "smithy.api#documentation": "

List of user-specified running instances that must not be stopped in order to free up the\n capacity needed to run the capacity task.

" + } + }, "DryRun": { "target": "com.amazonaws.outposts#DryRun", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

You can request a dry run to determine if the instance type and instance size changes is above or below available instance\n capacity. Requesting a dry run does not make any changes to your plan.

" + "smithy.api#documentation": "

You can request a dry run to determine if the instance type and instance size changes is\n above or below available instance capacity. Requesting a dry run does not make any changes to\n your plan.

" + } + }, + "TaskActionOnBlockingInstances": { + "target": "com.amazonaws.outposts#TaskActionOnBlockingInstances", + "traits": { + "smithy.api#documentation": "

Specify one of the following options in case an instance is blocking the capacity task\n from running.

\n " } } }, @@ -5178,6 +5670,12 @@ "smithy.api#documentation": "

List of the instance pools requested in the specified capacity task.

" } }, + "InstancesToExclude": { + "target": "com.amazonaws.outposts#InstancesToExclude", + "traits": { + "smithy.api#documentation": "

User-specified instances that must not be stopped in order to free up the capacity needed\n to run the capacity task.

" + } + }, "DryRun": { "target": "com.amazonaws.outposts#DryRun", "traits": { @@ -5214,6 +5712,12 @@ "traits": { "smithy.api#documentation": "

Date that the specified capacity task was last modified.

" } + }, + "TaskActionOnBlockingInstances": { + "target": "com.amazonaws.outposts#TaskActionOnBlockingInstances", + "traits": { + "smithy.api#documentation": "

User-specified option in case an instance is blocking the capacity task from\n running.

\n " + } } }, "traits": { @@ -5502,6 +6006,23 @@ "smithy.api#pattern": "^[\\S \\n]+$" } }, + "com.amazonaws.outposts#TaskActionOnBlockingInstances": { + "type": "enum", + "members": { + "WAIT_FOR_EVACUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAIT_FOR_EVACUATION" + } + }, + "FAIL_TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAIL_TASK" + } + } + } + }, "com.amazonaws.outposts#Token": { "type": "string", "traits": {