API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluations.
", + "smithy.api#documentation": "API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluation.
", "smithy.api#http": { "code": 202, "method": "POST", @@ -1209,6 +1218,94 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#CreateModelCopyJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelCopyJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelCopyJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-copy-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateModelCopyJobRequest": { + "type": "structure", + "members": { + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model to be copied.
", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "A name for the copied model.
", + "smithy.api#required": {} + } + }, + "modelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key that you use to encrypt the model copy.
" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateModelCopyJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model copy job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#CreateModelCustomizationJob": { "type": "operation", "input": { @@ -1244,7 +1341,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a fine-tuning job to customize a base model.
\nYou specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.\n
\nFor information on the format of training and validation data, see Prepare the datasets.
\n\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.
For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Creates a fine-tuning job to customize a base model.
\nYou specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.\n
\nFor information on the format of training and validation data, see Prepare the datasets.
\n\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.
For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 201, "method": "POST", @@ -1345,7 +1442,7 @@ "vpcConfig": { "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.
" + "smithy.api#documentation": "VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.
" } } }, @@ -1400,7 +1497,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 201, "method": "POST", @@ -1422,7 +1519,7 @@ "modelUnits": { "target": "com.amazonaws.bedrock#PositiveInteger", "traits": { - "smithy.api#documentation": "Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.
\nFor model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.
\nFor more information about what an MU specifies, contact your Amazon Web Services account manager.
", + "smithy.api#documentation": "Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.
\nFor model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.
\nFor more information about what an MU specifies, contact your Amazon Web Services account manager.
", "smithy.api#required": {} } }, @@ -1436,14 +1533,14 @@ "modelId": { "target": "com.amazonaws.bedrock#ModelIdentifier", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#required": {} } }, "commitmentDuration": { "target": "com.amazonaws.bedrock#CommitmentDuration", "traits": { - "smithy.api#documentation": "The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.
\nCustom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide
" + "smithy.api#documentation": "The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.
\nCustom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide\n
" } }, "tags": { @@ -1489,7 +1586,7 @@ "min": 1, "max": 63 }, - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,63}$" } }, "com.amazonaws.bedrock#CustomModelSummary": { @@ -1535,6 +1632,12 @@ "traits": { "smithy.api#documentation": "Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
" } + }, + "ownerAccountId": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "The unique identifier of the account that owns the model.
" + } } }, "traits": { @@ -1593,7 +1696,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "DELETE", @@ -1765,7 +1868,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "DELETE", @@ -2553,7 +2656,7 @@ } ], "traits": { - "smithy.api#documentation": "Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2703,7 +2806,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the properties associated with a model evaluation job, including the\n status of the job. For more information, see Model evaluations.
", + "smithy.api#documentation": "Retrieves the properties associated with a model evaluation job, including the\n status of the job. For more information, see Model evaluation.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -3071,6 +3174,137 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#GetModelCopyJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelCopyJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelCopyJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-copy-jobs/{jobArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJobRequest": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model copy job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model copy job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "The status of the model copy job.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the model copy job was created.
", + "smithy.api#required": {} + } + }, + "targetModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the copied model.
", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the copied model.
" + } + }, + "sourceAccountId": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "The unique identifier of the account that the model being copied originated from.
", + "smithy.api#required": {} + } + }, + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the original model being copied.
", + "smithy.api#required": {} + } + }, + "targetModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.
" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with the copied model.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "An error message for why the model copy job failed.
" + } + }, + "sourceModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the original model being copied.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#GetModelCustomizationJob": { "type": "operation", "input": { @@ -3097,7 +3331,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -3168,7 +3402,7 @@ "status": { "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", "traits": { - "smithy.api#documentation": "The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.
" + "smithy.api#documentation": "The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.
" } }, "failureMessage": { @@ -3342,7 +3576,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -3941,7 +4175,7 @@ "type": { "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", "traits": { - "smithy.api#documentation": "The type of PII entity. For example, Social Security Number.
", + "smithy.api#documentation": "The type of PII entity. For exampvle, Social Security Number.
", "smithy.api#required": {} } }, @@ -4845,7 +5079,7 @@ } }, "traits": { - "smithy.api#documentation": "In a model evaluation job that uses human workers you must\n define the name of the metric, and how you want that metric rated\n ratingMethod, and an optional description of the metric.
In a model evaluation job that uses human workers you must \n define the name of the metric, and how you want that metric rated\n ratingMethod, and an optional description of the metric.
Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -5055,14 +5289,14 @@ "maxResults": { "target": "com.amazonaws.bedrock#MaxResults", "traits": { - "smithy.api#documentation": "Maximum number of results to return in the response.
", + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
", + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The sort order of the results.
", "smithy.api#httpQuery": "sortOrder" } + }, + "isOwned": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).
Continuation token for the next request to list the next set of results.
" + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -5272,7 +5513,7 @@ "byCustomizationType": { "target": "com.amazonaws.bedrock#ModelCustomization", "traits": { - "smithy.api#documentation": "Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#httpQuery": "byCustomizationType" } }, @@ -5286,7 +5527,7 @@ "byInferenceType": { "target": "com.amazonaws.bedrock#InferenceType", "traits": { - "smithy.api#documentation": "Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#httpQuery": "byInferenceType" } } @@ -5400,6 +5641,145 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#ListModelCopyJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListModelCopyJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListModelCopyJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-copy-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelCopyJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListModelCopyJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs created after the specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs created before the specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs whose status matches the value that you specify.
", + "smithy.api#httpQuery": "statusEquals" + } + }, + "sourceAccountEquals": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.
", + "smithy.api#httpQuery": "sourceAccountEquals" + } + }, + "sourceModelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.
", + "smithy.api#httpQuery": "sourceModelArnEquals" + } + }, + "targetModelNameContains": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs in which the name of the copied model contains the string that you specify.
", + "smithy.api#httpQuery": "outputModelNameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The field to sort by in the returned list of model copy jobs.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies whether to sort the results in ascending or descending order.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelCopyJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
A list of information about each model copy job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#ListModelCustomizationJobs": { "type": "operation", "input": { @@ -5423,7 +5803,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.
\nFor more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.
\nFor more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -5472,14 +5852,14 @@ "maxResults": { "target": "com.amazonaws.bedrock#MaxResults", "traits": { - "smithy.api#documentation": "Maximum number of results to return in the response.
", + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
", + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Page continuation token to use in the next request.
" + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -5677,7 +6057,7 @@ } ], "traits": { - "smithy.api#documentation": "List the tags associated with the specified resource.
\nFor more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "List the tags associated with the specified resource.
\nFor more information, see Tagging resources in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -5797,6 +6177,138 @@ "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$" } }, + "com.amazonaws.bedrock#ModelCopyJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ModelCopyJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#ModelCopyJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelCopyJobSummary" + } + }, + "com.amazonaws.bedrock#ModelCopyJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resoource Name (ARN) of the model copy job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "The status of the model copy job.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the model copy job was created.
", + "smithy.api#required": {} + } + }, + "targetModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the copied model.
", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the copied model.
" + } + }, + "sourceAccountId": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "The unique identifier of the account that the model being copied originated from.
", + "smithy.api#required": {} + } + }, + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the original model being copied.
", + "smithy.api#required": {} + } + }, + "targetModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.
" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags associated with the copied model.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "If a model fails to be copied, a message describing why the job failed is included here.
" + } + }, + "sourceModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the original model being copied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about each model copy job.
\nThis data type is used in the following API operations:
\nStops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -6672,7 +7184,7 @@ } ], "traits": { - "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -6776,7 +7288,7 @@ } }, "traits": { - "smithy.api#documentation": "The request contains more tags than can be associated with a resource (50 tags per resource).\n The maximum number of tags includes both existing tags and those included in your current request.
", + "smithy.api#documentation": "The request contains more tags than can be associated with a resource (50 tags per resource). \n The maximum number of tags includes both existing tags and those included in your current request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6853,7 +7365,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -7072,7 +7584,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "PATCH", diff --git a/codegen/sdk-codegen/aws-models/controlcatalog.json b/codegen/sdk-codegen/aws-models/controlcatalog.json index 1f9a73a5036..32b25e7876f 100644 --- a/codegen/sdk-codegen/aws-models/controlcatalog.json +++ b/codegen/sdk-codegen/aws-models/controlcatalog.json @@ -163,6 +163,39 @@ "target": "com.amazonaws.controlcatalog#CommonControlSummary" } }, + "com.amazonaws.controlcatalog#ControlArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 34, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws(?:[-a-z]*)?):(controlcatalog|controltower):[a-zA-Z0-9-]*::control/[0-9a-zA-Z_\\-]+$" + } + }, + "com.amazonaws.controlcatalog#ControlBehavior": { + "type": "enum", + "members": { + "PREVENTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVENTIVE" + } + }, + "PROACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROACTIVE" + } + }, + "DETECTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETECTIVE" + } + } + } + }, "com.amazonaws.controlcatalog#ControlCatalog": { "type": "service", "version": "2018-05-10", @@ -170,6 +203,9 @@ { "target": "com.amazonaws.controlcatalog#CommonControlResource" }, + { + "target": "com.amazonaws.controlcatalog#ControlResource" + }, { "target": "com.amazonaws.controlcatalog#DomainResource" }, @@ -881,6 +917,88 @@ } } }, + "com.amazonaws.controlcatalog#ControlResource": { + "type": "resource", + "identifiers": { + "ControlArn": { + "target": "com.amazonaws.controlcatalog#ControlArn" + } + }, + "read": { + "target": "com.amazonaws.controlcatalog#GetControl" + }, + "list": { + "target": "com.amazonaws.controlcatalog#ListControls" + }, + "traits": { + "aws.api#arn": { + "template": "{ControlArn}", + "absolute": true + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "control" + } + } + }, + "com.amazonaws.controlcatalog#ControlScope": { + "type": "enum", + "members": { + "GLOBAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLOBAL" + } + }, + "REGIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGIONAL" + } + } + } + }, + "com.amazonaws.controlcatalog#ControlSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.controlcatalog#ControlArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The display name of the control.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the control, as it may appear in the console. Describes the functionality of the control.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Overview of information about a control.
" + } + }, + "com.amazonaws.controlcatalog#Controls": { + "type": "list", + "member": { + "target": "com.amazonaws.controlcatalog#ControlSummary" + } + }, + "com.amazonaws.controlcatalog#DeployableRegions": { + "type": "list", + "member": { + "target": "com.amazonaws.controlcatalog#RegionCode" + } + }, "com.amazonaws.controlcatalog#DomainArn": { "type": "string", "traits": { @@ -982,6 +1100,98 @@ "target": "com.amazonaws.controlcatalog#DomainSummary" } }, + "com.amazonaws.controlcatalog#GetControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.controlcatalog#GetControlRequest" + }, + "output": { + "target": "com.amazonaws.controlcatalog#GetControlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.controlcatalog#AccessDeniedException" + }, + { + "target": "com.amazonaws.controlcatalog#InternalServerException" + }, + { + "target": "com.amazonaws.controlcatalog#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controlcatalog#ThrottlingException" + }, + { + "target": "com.amazonaws.controlcatalog#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.
In the API response, controls that have the value GLOBAL in the Scope field do not show the DeployableRegions field, because it does not apply. Controls that have the value REGIONAL in the Scope field return a value for the DeployableRegions field, as shown in the example.
The Amazon Resource Name (ARN) of the control. It has one of the following formats:
\n\n Global format\n
\n\n arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}\n
\n Or Regional format\n
\n\n arn:{PARTITION}:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}\n
Here is a more general pattern that covers Amazon Web Services Control Tower and Control Catalog ARNs:
\n\n ^arn:(aws(?:[-a-z]*)?):(controlcatalog|controltower):[a-zA-Z0-9-]*::control/[0-9a-zA-Z_\\\\-]+$\n
The Amazon Resource Name (ARN) of the control.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The display name of the control.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of what the control does.
", + "smithy.api#required": {} + } + }, + "Behavior": { + "target": "com.amazonaws.controlcatalog#ControlBehavior", + "traits": { + "smithy.api#documentation": "A term that identifies the control's functional behavior. One of Preventive, Deteictive, Proactive\n
Returns a paginated list of all available controls in the Amazon Web Services Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-controls" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Controls" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controlcatalog#ListControlsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.controlcatalog#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.controlcatalog#MaxListControlsResults", + "traits": { + "smithy.api#documentation": "The maximum number of results on a page or for an API request call.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controlcatalog#ListControlsResponse": { + "type": "structure", + "members": { + "Controls": { + "target": "com.amazonaws.controlcatalog#Controls", + "traits": { + "smithy.api#documentation": "Returns a list of controls, given as structures of type controlSummary.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.controlcatalog#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.controlcatalog#ListDomains": { "type": "operation", "input": { @@ -1260,6 +1551,15 @@ } } }, + "com.amazonaws.controlcatalog#MaxListControlsResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.controlcatalog#MaxListDomainsResults": { "type": "integer", "traits": { @@ -1408,6 +1708,46 @@ } } }, + "com.amazonaws.controlcatalog#RegionCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9-]{1,128}$" + } + }, + "com.amazonaws.controlcatalog#RegionConfiguration": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.controlcatalog#ControlScope", + "traits": { + "smithy.api#documentation": "The coverage of the control, if deployed. Scope is an enumerated type, with value Regional, or Global. A control with Global scope is effective in all Amazon Web Services Regions, regardless of the Region from which it is enabled, or to which it is deployed. A control implemented by an SCP is usually Global in scope. A control with Regional scope has operations that are restricted specifically to the Region from which it is enabled and to which it is deployed. Controls implemented by Config rules and CloudFormation hooks usually are Regional in scope. Security Hub controls usually are Regional in scope.
Regions in which the control is available to be deployed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control currently is available for deployment.
\nIf you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the RegionConfiguration API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions A,B,and C while the control is available in Regions A, B, C, and D, you'd see a response with DeployableRegions of A, B, C, and D for a control with REGIONAL scope, even though you may not intend to deploy the control in Region D, because you do not govern it through your landing zone.
The requested resource does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.controlcatalog#ThrottlingException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/controltower.json b/codegen/sdk-codegen/aws-models/controltower.json index 996779814b1..b70920fe1fb 100644 --- a/codegen/sdk-codegen/aws-models/controltower.json +++ b/codegen/sdk-codegen/aws-models/controltower.json @@ -67,7 +67,7 @@ "x-amzn-trace-id" ] }, - "smithy.api#documentation": "Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
\n\n \n Controls\n \n
\n\n DisableControl\n
\n\n EnableControl\n
\n\n GetEnabledControl\n
\n\n ListEnabledControls\n
\n\n UpdateEnabledControl\n
\n\n \n Landing zones\n \n
\n\n CreateLandingZone\n
\n\n DeleteLandingZone\n
\n\n GetLandingZone\n
\n\n ListLandingZones\n
\n\n ResetLandingZone\n
\n\n UpdateLandingZone\n
\n\n \n Baselines\n \n
\n\n DisableBaseline\n
\n\n EnableBaseline\n
\n\n GetBaseline\n
\n\n GetBaselineOperation\n
\n\n GetEnabledBaseline\n
\n\n ListBaselines\n
\n\n ListEnabledBaselines\n
\n\n ResetEnabledBaseline\n
\n\n Tagging\n
\n\n ListTagsForResource\n
\n\n TagResource\n
\n\n UntagResource\n
\nFor more information about these types of resources, see the \n Amazon Web Services Control Tower User Guide\n .
\n\n About control APIs\n
\nThese interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
\nTo call these APIs, you'll need to know:
\nthe controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
\n\n To get the controlIdentifier for your Amazon Web Services Control Tower\n control:\n
The controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
The controlIdentifier is unique in each Amazon Web Services Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the \n Amazon Web Services Control Tower Controls Reference Guide\n . Remember that Mandatory controls cannot be added or removed.
\n\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n
\n Example:\n
\n\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n
\n To get the targetIdentifier:\n
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
\n\n OU ARN format:\n
\n\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n
\n About landing zone APIs\n
\nYou can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
\nFor an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.
\n\n About baseline APIs\n
\nYou can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
\nThe individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
\n\n Details and examples\n
\n\n Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation\n
\nTo view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n
\n\n Recording API Requests\n
\nAmazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.
", + "smithy.api#documentation": "Amazon Web Services Control Tower offers application programming interface (API)\n operations that support programmatic interaction with these types of resources:
\n\n \n Controls\n \n
\n\n DisableControl\n
\n\n EnableControl\n
\n\n GetEnabledControl\n
\n\n ListEnabledControls\n
\n\n UpdateEnabledControl\n
\n\n \n Landing\n zones\n \n
\n\n CreateLandingZone\n
\n\n DeleteLandingZone\n
\n\n GetLandingZone\n
\n\n ListLandingZones\n
\n\n ResetLandingZone\n
\n\n UpdateLandingZone\n
\n\n \n Baselines\n \n
\n\n DisableBaseline\n
\n\n EnableBaseline\n
\n\n GetBaseline\n
\n\n GetBaselineOperation\n
\n\n GetEnabledBaseline\n
\n\n ListBaselines\n
\n\n ListEnabledBaselines\n
\n\n ResetEnabledBaseline\n
\n\n \n Tagging\n \n
\n\n ListTagsForResource\n
\n\n TagResource\n
\n\n UntagResource\n
\nFor more information about these types of resources, see the \n Amazon Web Services Control Tower User Guide\n .
\n\n About control APIs\n
\nThese interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
\nTo call these APIs, you'll need to know:
\nthe controlIdentifier for the control--or guardrail--you are\n targeting.
the ARN associated with the target organizational unit (OU), which we call the\n targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
\n\n To get the controlIdentifier for your Amazon Web Services Control Tower control:\n
The controlIdentifier is an ARN that is specified for each control. You can\n view the controlIdentifier in the console on the Control\n details page, as well as in the documentation.
\n About identifiers for Amazon Web Services Control Tower\n
\nThe Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each\n control. You can find the controlIdentifier for each Region and control in the\n Tables of control metadata or the Control\n availability by Region tables in the Amazon Web Services Control Tower\n Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower\n legacy Strongly recommended and Elective controls\n is given in Resource\n identifiers for APIs and controls in the \n Amazon Web Services Control Tower Controls Reference Guide\n . Remember\n that Mandatory controls cannot be added or removed.
\n\n Some controls have two identifiers\n
\n\n ARN format for Amazon Web Services Control\n Tower:\n arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}\n
\n Example:\n
\n\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n
\n ARN format for Amazon Web Services Control\n Catalog:\n arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}\n
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the \n Amazon Web Services Control Tower Controls Reference\n Guide\n , or in the Amazon Web Services Control Tower console, on the\n Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as\n GetEnabledControl and ListEnabledControls always return an\n ARN of the same type given when the control was enabled.
\n To get the targetIdentifier:\n
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the\n Organizational unit details page associated with that\n OU.
\n\n OU ARN format:\n
\n\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n
\n About landing zone APIs\n
\nYou can configure and launch an Amazon Web Services Control Tower landing zone with APIs.\n For an introduction and steps, see Getting started with\n Amazon Web Services Control Tower using APIs.
\nFor an overview of landing zone API operations, see \n Amazon Web Services Control Tower supports landing zone APIs. The individual API\n operations for landing zones are detailed in this document, the API reference\n manual, in the \"Actions\" section.
\n\n About baseline APIs\n
\nYou can apply the AWSControlTowerBaseline baseline to an organizational\n unit (OU) as a way to register the OU with Amazon Web Services Control Tower,\n programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration\n with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services\n Control Tower enables for your landing zone, on your behalf, when setting up the landing\n zone. These baselines are read-only baselines.
\nThe individual API operations for baselines are detailed in this document, the API\n reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
\n\n About Amazon Web Services Control Catalog identifiers\n
\nThe EnableControl and DisableControl API operations can\n be called by specifying either the Amazon Web Services Control Tower identifer or the\n Amazon Web Services Control Catalog identifier. The API response returns the same\n type of identifier that you specified when calling the API.
If you use an Amazon Web Services Control Tower identifier to call the\n EnableControl API, and then call EnableControl again\n with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control\n Tower returns an error message stating that the control is already enabled. Similar\n behavior applies to the DisableControl API operation.
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
\n\n Details and examples\n
\n\n Creating Amazon Web Services Control Tower resources with Amazon Web Services\n CloudFormation\n
\nTo view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n
\n\n Recording API Requests\n
\nAmazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that\n records Amazon Web Services API calls for your Amazon Web Services account and delivers log\n files to an Amazon S3 bucket. By using information collected by CloudTrail, you can\n determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its\n support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the\n Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including\n how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.
", "smithy.api#title": "AWS Control Tower", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk-codegen/aws-models/iam.json b/codegen/sdk-codegen/aws-models/iam.json index b03777a8607..4156b62b798 100644 --- a/codegen/sdk-codegen/aws-models/iam.json +++ b/codegen/sdk-codegen/aws-models/iam.json @@ -7696,6 +7696,21 @@ "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], + "smithy.test#smokeTests": [ + { + "id": "GetUserFailure", + "params": { + "UserName": "fake_user" + }, + "vendorParams": { + "region": "us-east-1" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ], "smithy.waiters#waitable": { "UserExists": { "acceptors": [ @@ -10918,7 +10933,20 @@ "outputToken": "Marker", "items": "Users", "pageSize": "MaxItems" - } + }, + "smithy.test#smokeTests": [ + { + "id": "ListUsersSuccess", + "params": {}, + "vendorParams": { + "region": "us-east-1" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.iam#ListUsersRequest": { diff --git a/codegen/sdk-codegen/aws-models/memorydb.json b/codegen/sdk-codegen/aws-models/memorydb.json index e2af619d4d6..a3376ad257d 100644 --- a/codegen/sdk-codegen/aws-models/memorydb.json +++ b/codegen/sdk-codegen/aws-models/memorydb.json @@ -2593,7 +2593,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a cluster. It also deletes all associated nodes and node endpoints
" + "smithy.api#documentation": "Deletes a cluster. It also deletes all associated nodes and node endpoints
\n\n CreateSnapshot permission is required to create a final snapshot. \n Without this permission, the API call will fail with an Access Denied exception.
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
" + } + }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -11096,6 +11102,12 @@ "smithy.api#documentation": "The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
" } }, + "MinACU": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
" + } + }, "ComputeRedundancy": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { @@ -12137,19 +12149,19 @@ "SkipFinalSnapshot": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.
\nYou must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
Specifies whether to skip the creation of a final DB cluster snapshot before RDS\n deletes the DB cluster. If you set this value to true, RDS doesn't create a\n final DB cluster snapshot. If you set this value to false or don't specify\n it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this\n parameter is disabled, so RDS creates a final DB cluster snapshot.
If SkipFinalSnapshot is disabled, you must specify a value for the\n FinalDBSnapshotIdentifier parameter.
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.
Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.
Constraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.
If you specify this parameter and also skip the creation of a final DB cluster\n snapshot with the SkipFinalShapshot parameter, the request results in\n an error.
Constraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nSpecifies whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.\n
\nYou must delete automated backups for Amazon RDS Multi-AZ DB clusters. For more information about managing automated backups for RDS Multi-AZ DB clusters, see Managing automated backups.
\nSpecifies whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.
" } } }, @@ -13909,7 +13921,7 @@ "Source": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A specific source to return parameters for.
\nValid Values:
\n\n user\n
\n engine\n
\n service\n
A specific source to return parameters for.
\nValid Values:
\n\n customer\n
\n engine\n
\n service\n
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
" } + }, + "MinACU": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
" + } } }, "traits": { @@ -23780,13 +23798,13 @@ "DBSecurityGroupMemberships": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "A list of DBSecurityGroupMembership name strings used for this option.
" + "smithy.api#documentation": "A list of DB security groups used for this option.
" } }, "VpcSecurityGroupMemberships": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of VpcSecurityGroupMembership name strings used for this option.
" + "smithy.api#documentation": "A list of VPC security group names used for this option.
" } }, "OptionSettings": { @@ -23797,7 +23815,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of all available options
" + "smithy.api#documentation": "A list of all available options for an option group.
" } }, "com.amazonaws.rds#OptionConfigurationList": { @@ -30782,7 +30800,7 @@ } }, "traits": { - "smithy.api#documentation": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
\nFor more information, see\n Tagging Amazon RDS Resources in the Amazon RDS User Guide\n or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
\nFor more information, see\n Tagging Amazon RDS resources in the Amazon RDS User Guide or \n Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.\n
" } }, "com.amazonaws.rds#TagList": { @@ -30794,7 +30812,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of tags.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A list of tags.
\nFor more information, see\n Tagging Amazon RDS resources in the Amazon RDS User Guide or \n Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.\n
" } }, "com.amazonaws.rds#TagListMessage": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 09b64b049f5..313708d397c 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -2586,6 +2586,18 @@ "smithy.api#documentation": "Lists a summary of the properties of an association. An association is an entity that\n links other lineage or experiment entities. An example would be an association between a\n training job and a model.
" } }, + "com.amazonaws.sagemaker#AssumableRoleArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RoleArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.sagemaker#AsyncInferenceClientConfig": { "type": "structure", "members": { @@ -27145,6 +27157,26 @@ "smithy.api#pattern": "^\\d+$" } }, + "com.amazonaws.sagemaker#EmrSettings": { + "type": "structure", + "members": { + "AssumableRoleArns": { + "target": "com.amazonaws.sagemaker#AssumableRoleArns", + "traits": { + "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of\n SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR\n Serverless applications. These roles define the permissions and access policies required\n when performing Amazon EMR-related operations, such as listing, connecting to, or terminating\n Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in\n cross-account access scenarios, where the Amazon EMR resources (clusters or serverless\n applications) are located in a different Amazon Web Services account than the SageMaker\n domain.
" + } + }, + "ExecutionRoleArns": { + "target": "com.amazonaws.sagemaker#ExecutionRoleArns", + "traits": { + "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances\n or job execution environments to access other Amazon Web Services services and resources needed during the \n runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other\n Amazon Web Services services based on the particular workload requirements.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.
" + } + }, "com.amazonaws.sagemaker#EnableCapture": { "type": "boolean" }, @@ -27918,6 +27950,18 @@ } } }, + "com.amazonaws.sagemaker#ExecutionRoleArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RoleArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.sagemaker#ExecutionRoleIdentityConfig": { "type": "enum", "members": { @@ -35095,6 +35139,12 @@ "traits": { "smithy.api#documentation": "A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
" } + }, + "EmrSettings": { + "target": "com.amazonaws.sagemaker#EmrSettings", + "traits": { + "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/ssm-quicksetup.json b/codegen/sdk-codegen/aws-models/ssm-quicksetup.json new file mode 100644 index 00000000000..be928d72056 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/ssm-quicksetup.json @@ -0,0 +1,2223 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.ssmquicksetup#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The requester has insufficient permissions to perform the operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinition": { + "type": "structure", + "members": { + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the Quick Setup configuration.
", + "smithy.api#pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", + "traits": { + "smithy.api#documentation": "A list of key-value pairs containing the required parameters for the configuration\n type.
", + "smithy.api#required": {} + } + }, + "TypeVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the Quick Setup type used.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "LocalDeploymentExecutionRoleName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the IAM role used to deploy local\n configurations.
", + "smithy.api#pattern": "^[\\w+=,.@-]{1,64}$" + } + }, + "LocalDeploymentAdministrationRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role used to administrate local configuration\n deployments.
" + } + }, + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the configuration definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of a Quick Setup configuration.
" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionInput": { + "type": "structure", + "members": { + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the Quick Setup configuration.
", + "smithy.api#pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", + "traits": { + "smithy.api#documentation": "The parameters for the configuration definition type. Parameters for configuration\n definitions vary based the configuration type. The following tables outline the\n parameters for each configuration type.
\n\n DelegatedAccountId\n
Description: (Required) The ID of the\n delegated administrator account.
\n\n TargetOrganizationalUnits\n
Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n TargetTagKey\n
Description: (Required) The tag key assigned\n to the instances you want to target.
\n\n TargetTagValue\n
Description: (Required) The value of the tag\n key assigned to the instances you want to\n target.
\n\n ICalendarString\n
Description: (Required) An iCalendar\n formatted string containing the schedule you want\n Change Manager to use.
\n\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n UpdateSSMAgent\n
Description: (Optional) A boolean value that\n determines whether the SSM Agent is updated on the\n target instances every 2 weeks. The default value\n is \"true\".
\n TargetOrganizationalUnits\n
Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n SelectedAggregatorRegion\n
Description: (Required) The Amazon Web Services Region where you want to create the\n aggregator index.
\n\n ReplaceExistingAggregator\n
Description: (Required) A boolean value that\n determines whether to demote an existing\n aggregator if it is in a Region that differs from\n the value you specify for the\n SelectedAggregatorRegion.
\n TargetOrganizationalUnits\n
Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n DelegatedAccountId\n
Description: (Required) The ID of the\n delegated administrator account.
\n\n JobFunction\n
Description: (Required) The name for the\n Change Manager job function.
\n\n PermissionType\n
Description: (Optional) Specifies whether\n you want to use default administrator permissions\n for the job function role, or provide a custom\n IAM policy. The valid values are\n CustomPermissions and\n AdminPermissions. The default value\n for the parameter is\n CustomerPermissions.
\n CustomPermissions\n
Description: (Optional) A JSON string\n containing the IAM policy you want\n your job function to use. You must provide a value\n for this parameter if you specify\n CustomPermissions for the\n PermissionType parameter.
\n TargetOrganizationalUnits\n
Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n AnalyseAllResources\n
Description: (Optional) A boolean value that\n determines whether DevOps Guru analyzes all\n CloudFormation stacks in the account. The\n default value is \"false\".
\n EnableSnsNotifications\n
Description: (Optional) A boolean value that\n determines whether DevOps Guru sends\n notifications when an insight is created. The\n default value is \"true\".
\n EnableSsmOpsItems\n
Description: (Optional) A boolean value that\n determines whether DevOps Guru creates an\n OpsCenter OpsItem when an insight is created. The\n default value is \"true\".
\n EnableDriftRemediation\n
Description: (Optional) A boolean value that\n determines whether a drift remediation schedule is\n used. The default value is\n \"false\".
\n RemediationSchedule\n
Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are rate(30 days),\n rate(14 days), rate(1\n days), and none. The default\n value is \"none\".
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n DelegatedAccountId\n
Description: (Optional) The ID of the\n delegated administrator account. This parameter is\n required for Organization deployments.
\n\n RemediationSchedule\n
Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are rate(30 days),\n rate(14 days), rate(2\n days), and none. The default\n value is \"none\".
\n CPackNames\n
Description: (Required) A comma separated\n list of Config conformance\n packs.
\n\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) The ID of the root\n of your Organization. This configuration type\n doesn't currently support choosing specific OUs.\n The configuration will be deployed to all the OUs\n in the Organization.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n RecordAllResources\n
Description: (Optional) A boolean value that\n determines whether all supported resources are\n recorded. The default value is\n \"true\".
\n ResourceTypesToRecord\n
Description: (Optional) A comma separated\n list of resource types you want to record.
\n\n RecordGlobalResourceTypes\n
Description: (Optional) A boolean value that\n determines whether global resources are recorded\n with all resource configurations. The default\n value is \"false\".
\n GlobalResourceTypesRegion\n
Description: (Optional) Determines the\n Amazon Web Services Region where global resources\n are recorded.
\n\n UseCustomBucket\n
Description: (Optional) A boolean value that\n determines whether a custom Amazon S3\n bucket is used for delivery. The default value is\n \"false\".
\n DeliveryBucketName\n
Description: (Optional) The name of the\n Amazon S3 bucket you want Config to deliver configuration snapshots and\n configuration history files to.
\n\n DeliveryBucketPrefix\n
Description: (Optional) The key prefix you\n want to use in the custom Amazon S3\n bucket.
\n\n NotificationOptions\n
Description: (Optional) Determines the\n notification configuration for the recorder. The\n valid values are NoStreaming,\n UseExistingTopic, and\n CreateTopic. The default value is\n NoStreaming.
\n CustomDeliveryTopicAccountId\n
Description: (Optional) The ID of the\n Amazon Web Services account where the Amazon SNS topic you want to use for notifications\n resides. You must specify a value for this\n parameter if you use the\n UseExistingTopic notification\n option.
\n CustomDeliveryTopicName\n
Description: (Optional) The name of the\n Amazon SNS topic you want to use for\n notifications. You must specify a value for this\n parameter if you use the\n UseExistingTopic notification\n option.
\n RemediationSchedule\n
Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are rate(30 days),\n rate(7 days), rate(1\n days), and none. The default\n value is \"none\".
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) The ID of the root\n of your Organization. This configuration type\n doesn't currently support choosing specific OUs.\n The configuration will be deployed to all the OUs\n in the Organization.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n UpdateSSMAgent\n
Description: (Optional) A boolean value that\n determines whether the SSM Agent is updated on the\n target instances every 2 weeks. The default value\n is \"true\".
\n UpdateEc2LaunchAgent\n
Description: (Optional) A boolean value that\n determines whether the EC2 Launch agent is updated\n on the target instances every month. The default\n value is \"false\".
\n CollectInventory\n
Description: (Optional) A boolean value that\n determines whether the EC2 Launch agent is updated\n on the target instances every month. The default\n value is \"true\".
\n ScanInstances\n
Description: (Optional) A boolean value that\n determines whether the target instances are\n scanned daily for available patches. The default\n value is \"true\".
\n InstallCloudWatchAgent\n
Description: (Optional) A boolean value that\n determines whether the Amazon CloudWatch agent\n is installed on the target instances. The default\n value is \"false\".
\n UpdateCloudWatchAgent\n
Description: (Optional) A boolean value that\n determines whether the Amazon CloudWatch agent\n is updated on the target instances every month.\n The default value is \"false\".
\n IsPolicyAttachAllowed\n
Description: (Optional) A boolean value that\n determines whether Quick Setup attaches policies\n to instances profiles already associated with the\n target instances. The default value is\n \"false\".
\n TargetType\n
Description: (Optional) Determines how\n instances are targeted for local account\n deployments. Don't specify a value for this\n parameter if you're deploying to OUs. The valid\n values are *,\n InstanceIds,\n ResourceGroups, and\n Tags. Use * to target\n all instances in the account.
\n TargetInstances\n
Description: (Optional) A comma separated\n list of instance IDs. You must provide a value for\n this parameter if you specify\n InstanceIds for the\n TargetType parameter.
\n TargetTagKey\n
Description: (Optional) The tag key assigned\n to the instances you want to target. You must\n provide a value for this parameter if you specify\n Tags for the TargetType\n parameter.
\n TargetTagValue\n
Description: (Optional) The value of the tag\n key assigned to the instances you want to target.\n You must provide a value for this parameter if you\n specify Tags for the\n TargetType parameter.
\n ResourceGroupName\n
Description: (Optional) The name of the\n resource group associated with the instances you\n want to target. You must provide a value for this\n parameter if you specify\n ResourceGroups for the\n TargetType parameter.
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n PackagesToInstall\n
Description: (Required) A comma separated\n list of packages you want to install on the target\n instances. The valid values are\n AWSEFSTools, AWSCWAgent,\n and AWSEC2LaunchAgent.
\n RemediationSchedule\n
Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are rate(30 days),\n rate(14 days), rate(2\n days), and none. The default\n value is \"rate(30 days)\".
\n IsPolicyAttachAllowed\n
Description: (Optional) A boolean value that\n determines whether Quick Setup attaches policies\n to instances profiles already associated with the\n target instances. The default value is\n \"false\".
\n TargetType\n
Description: (Optional) Determines how\n instances are targeted for local account\n deployments. Don't specify a value for this\n parameter if you're deploying to OUs. The valid\n values are *,\n InstanceIds,\n ResourceGroups, and\n Tags. Use * to target\n all instances in the account.
\n TargetInstances\n
Description: (Optional) A comma separated\n list of instance IDs. You must provide a value for\n this parameter if you specify\n InstanceIds for the\n TargetType parameter.
\n TargetTagKey\n
Description: (Required) The tag key assigned\n to the instances you want to target. You must\n provide a value for this parameter if you specify\n Tags for the TargetType\n parameter.
\n TargetTagValue\n
Description: (Required) The value of the tag\n key assigned to the instances you want to target.\n You must provide a value for this parameter if you\n specify Tags for the\n TargetType parameter.
\n ResourceGroupName\n
Description: (Required) The name of the\n resource group associated with the instances you\n want to target. You must provide a value for this\n parameter if you specify\n ResourceGroups for the\n TargetType parameter.
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n PatchPolicyName\n
Description: (Required) A name for the patch\n policy. The value you provide is applied to target\n Amazon EC2 instances as a tag.
\n\n SelectedPatchBaselines\n
Description: (Required) An array of JSON\n objects containing the information for the patch\n baselines to include in your patch policy.
\n\n PatchBaselineUseDefault\n
Description: (Optional) A boolean value that\n determines whether the selected patch baselines\n are all Amazon Web Services provided.
\n\n ConfigurationOptionsPatchOperation\n
Description: (Optional) Determines whether\n target instances scan for available patches, or\n scan and install available patches. The valid\n values are Scan and\n ScanAndInstall. The default value for\n the parameter is Scan.
\n ConfigurationOptionsScanValue\n
Description: (Optional) A cron expression\n that is used as the schedule for when instances\n scan for available patches.
\n\n ConfigurationOptionsInstallValue\n
Description: (Optional) A cron expression\n that is used as the schedule for when instances\n install available patches.
\n\n ConfigurationOptionsScanNextInterval\n
Description: (Optional) A boolean value that\n determines whether instances should scan for\n available patches at the next cron interval. The\n default value is \"false\".
\n ConfigurationOptionsInstallNextInterval\n
Description: (Optional) A boolean value that\n determines whether instances should scan for\n available patches at the next cron interval. The\n default value is \"false\".
\n RebootOption\n
Description: (Optional) A boolean value that\n determines whether instances are rebooted after\n patches are installed. The default value is\n \"false\".
\n IsPolicyAttachAllowed\n
Description: (Optional) A boolean value that\n determines whether Quick Setup attaches policies\n to instances profiles already associated with the\n target instances. The default value is\n \"false\".
\n OutputLogEnableS3\n
Description: (Optional) A boolean value that\n determines whether command output logs are sent to\n Amazon S3.
\n\n OutputS3Location\n
Description: (Optional) A JSON string\n containing information about the Amazon S3\n bucket where you want to store the output details\n of the request.
\n\n OutputS3BucketRegion\n
Description: (Optional) The Amazon Web Services Region where the Amazon S3\n bucket you want Config to deliver\n command output to is located.
\n\n OutputS3BucketName\n
Description: (Optional) The name of the\n Amazon S3 bucket you want Config to deliver command output to.
\n\n OutputS3KeyPrefix\n
Description: (Optional) The key prefix you\n want to use in the custom Amazon S3\n bucket.
\n\n TargetType\n
Description: (Optional) Determines how\n instances are targeted for local account\n deployments. Don't specify a value for this\n parameter if you're deploying to OUs. The valid\n values are *,\n InstanceIds,\n ResourceGroups, and\n Tags. Use * to target\n all instances in the account.
\n TargetInstances\n
Description: (Optional) A comma separated\n list of instance IDs. You must provide a value for\n this parameter if you specify\n InstanceIds for the\n TargetType parameter.
\n TargetTagKey\n
Description: (Required) The tag key assigned\n to the instances you want to target. You must\n provide a value for this parameter if you specify\n Tags for the TargetType\n parameter.
\n TargetTagValue\n
Description: (Required) The value of the tag\n key assigned to the instances you want to target.\n You must provide a value for this parameter if you\n specify Tags for the\n TargetType parameter.
\n ResourceGroupName\n
Description: (Required) The name of the\n resource group associated with the instances you\n want to target. You must provide a value for this\n parameter if you specify\n ResourceGroups for the\n TargetType parameter.
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\nThe version of the Quick Setup type to use.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "LocalDeploymentExecutionRoleName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the IAM role used to deploy local\n configurations.
", + "smithy.api#pattern": "^[\\w+=,.@-]{1,64}$" + } + }, + "LocalDeploymentAdministrationRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role used to administrate local configuration\n deployments.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the preferences and options for a configuration definition.
" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionSummary" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionSummary": { + "type": "structure", + "members": { + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the configuration definition.
" + } + }, + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the Quick Setup configuration used by the configuration\n definition.
" + } + }, + "TypeVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the Quick Setup type used by the configuration definition.
" + } + }, + "FirstClassParameters": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", + "traits": { + "smithy.api#documentation": "The common parameters and values for the configuration definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summarized definition of a Quick Setup configuration definition.
" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionsInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionInput" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinition" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationManagerList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationManagerSummary" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationManagerSummary": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the Quick Setup configuration.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the configuration.
" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the configuration
" + } + }, + "StatusSummaries": { + "target": "com.amazonaws.ssmquicksetup#StatusSummariesList", + "traits": { + "smithy.api#documentation": "Summaries of the state of the configuration manager. These summaries include an\n aggregate of the statuses from the configuration definition associated with the\n configuration manager. This includes deployment statuses, association statuses,\n drift statuses, health checks, and more.
" + } + }, + "ConfigurationDefinitionSummaries": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionSummariesList", + "traits": { + "smithy.api#documentation": "A summary of the Quick Setup configuration definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a Quick Setup configuration manager.
" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationParametersMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9+=@_\\/\\s-]+$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 40960 + } + } + } + }, + "com.amazonaws.ssmquicksetup#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "Another request is being processed. Wait a few minutes and try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.ssmquicksetup#CreateConfigurationManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#CreateConfigurationManagerInput" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#CreateConfigurationManagerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Quick Setup configuration manager resource. This object is a collection\n of desired state configurations for multiple configuration definitions and\n summaries describing the deployments of those definitions.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configurationManager" + } + } + }, + "com.amazonaws.ssmquicksetup#CreateConfigurationManagerInput": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A name for the configuration manager.
", + "smithy.api#pattern": "^[ A-Za-z0-9._-]{0,120}$" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the configuration manager.
", + "smithy.api#pattern": "^.{0,512}$" + } + }, + "ConfigurationDefinitions": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionsInputList", + "traits": { + "smithy.api#documentation": "The definition of the Quick Setup configuration that the configuration manager\n deploys.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.ssmquicksetup#TagsMap", + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata to assign to the configuration manager.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#CreateConfigurationManagerOutput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN for the newly created configuration manager.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#DeleteConfigurationManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#DeleteConfigurationManagerInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a configuration manager.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/configurationManager/{ManagerArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#DeleteConfigurationManagerInput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the configuration manager.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^arn:aws:ssm-quicksetup:([^:]+):(\\d{12}):configuration-manager/[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#Filter": { + "type": "structure", + "members": { + "Key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key for the filter.
", + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9+=@_\\/\\s-]*$", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.ssmquicksetup#FilterValues", + "traits": { + "smithy.api#documentation": "The values for the filter keys.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A key-value pair to filter results.
" + } + }, + "com.amazonaws.ssmquicksetup#FilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9+=@_\\/\\s-]*$" + } + } + }, + "com.amazonaws.ssmquicksetup#FiltersList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#Filter" + } + }, + "com.amazonaws.ssmquicksetup#GetConfigurationManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#GetConfigurationManagerInput" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#GetConfigurationManagerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a configuration manager.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configurationManager/{ManagerArn}" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetConfigurationManagerFailure", + "params": { + "ManagerArn": "arn:aws:ssm-quicksetup:us-east-1:602768233532:configuration-manager/7cac1a1b-64a9-4c9a-97e8-8c68928b8f13" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.ssmquicksetup#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.ssmquicksetup#GetConfigurationManagerInput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the configuration manager.
", + "smithy.api#httpLabel": {}, + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^arn:aws:ssm-quicksetup:([^:]+):(\\d{12}):configuration-manager/[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#GetConfigurationManagerOutput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the configuration manager.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the configuration manager.
" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the configuration manager.
" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The datetime stamp when the configuration manager was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "LastModifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The datetime stamp when the configuration manager was last updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "StatusSummaries": { + "target": "com.amazonaws.ssmquicksetup#StatusSummariesList", + "traits": { + "smithy.api#documentation": "A summary of the state of the configuration manager. This includes deployment\n statuses, association statuses, drift statuses, health checks, and more.
" + } + }, + "ConfigurationDefinitions": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionsList", + "traits": { + "smithy.api#documentation": "The configuration definitions association with the configuration manager.
" + } + }, + "Tags": { + "target": "com.amazonaws.ssmquicksetup#TagsMap", + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata to assign to the configuration manager.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#GetServiceSettings": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#GetServiceSettingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/serviceSettings" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmquicksetup#GetServiceSettingsOutput": { + "type": "structure", + "members": { + "ServiceSettings": { + "target": "com.amazonaws.ssmquicksetup#ServiceSettings", + "traits": { + "smithy.api#documentation": "Returns details about the settings for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#IAMRoleArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::IAM::Role" + } + } + }, + "com.amazonaws.ssmquicksetup#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "An error occurred on the server side.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.ssmquicksetup#ListConfigurationManagers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#ListConfigurationManagersInput" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#ListConfigurationManagersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns Quick Setup configuration managers.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/listConfigurationManagers" + }, + "smithy.api#paginated": { + "items": "ConfigurationManagersList", + "inputToken": "StartingToken", + "outputToken": "NextToken", + "pageSize": "MaxItems" + }, + "smithy.test#smokeTests": [ + { + "id": "ListConfigurationManagersSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.ssmquicksetup#ListConfigurationManagersInput": { + "type": "structure", + "members": { + "StartingToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token to use when requesting a specific set of items from a list.
", + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[A-Za-z0-9+=@_\\/\\s-]*$" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of configuration managers that are returned by the\n request.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "Filters": { + "target": "com.amazonaws.ssmquicksetup#FiltersList", + "traits": { + "smithy.api#documentation": "Filters the results returned by the request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#ListConfigurationManagersOutput": { + "type": "structure", + "members": { + "ConfigurationManagersList": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationManagerList", + "traits": { + "smithy.api#documentation": "The configuration managers returned by the request.
" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token to use when requesting the next set of configuration managers. If there\n are no additional operations to return, the string is empty.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#ListQuickSetupTypes": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#ListQuickSetupTypesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the available Quick Setup types.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/listQuickSetupTypes" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "ListQuickSetupTypesSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.ssmquicksetup#ListQuickSetupTypesOutput": { + "type": "structure", + "members": { + "QuickSetupTypeList": { + "target": "com.amazonaws.ssmquicksetup#QuickSetupTypeList", + "traits": { + "smithy.api#documentation": "An array of Quick Setup types.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns tags assigned to the resource.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmquicksetup#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource the tag is assigned to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.ssmquicksetup#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata assigned to the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#QuickSetup": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.ssmquicksetup#CreateConfigurationManager" + }, + { + "target": "com.amazonaws.ssmquicksetup#DeleteConfigurationManager" + }, + { + "target": "com.amazonaws.ssmquicksetup#GetConfigurationManager" + }, + { + "target": "com.amazonaws.ssmquicksetup#GetServiceSettings" + }, + { + "target": "com.amazonaws.ssmquicksetup#ListConfigurationManagers" + }, + { + "target": "com.amazonaws.ssmquicksetup#ListQuickSetupTypes" + }, + { + "target": "com.amazonaws.ssmquicksetup#ListTagsForResource" + }, + { + "target": "com.amazonaws.ssmquicksetup#TagResource" + }, + { + "target": "com.amazonaws.ssmquicksetup#UntagResource" + }, + { + "target": "com.amazonaws.ssmquicksetup#UpdateConfigurationDefinition" + }, + { + "target": "com.amazonaws.ssmquicksetup#UpdateConfigurationManager" + }, + { + "target": "com.amazonaws.ssmquicksetup#UpdateServiceSettings" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SSM QuickSetup", + "arnNamespace": "ssm-quicksetup", + "cloudTrailEventSource": "ssm-quicksetup.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "ssm-quicksetup" + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "Authorization", + "Content-Type", + "Credentials", + "X-Amz-Date", + "X-Api-Key", + "X-Amz-Security-Token", + "x-amz-content-sha256", + "X-Amz-User-Agent" + ] + }, + "smithy.api#documentation": "Quick Setup helps you quickly configure frequently used services and features with\n recommended best practices. Quick Setup simplifies setting up services, including\n Systems Manager, by automating common or recommended tasks.
", + "smithy.api#title": "AWS Systems Manager QuickSetup", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-quicksetup-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-quicksetup-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-quicksetup.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-quicksetup.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.ssmquicksetup#QuickSetupTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#QuickSetupTypeOutput" + } + }, + "com.amazonaws.ssmquicksetup#QuickSetupTypeOutput": { + "type": "structure", + "members": { + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the Quick Setup configuration.
" + } + }, + "LatestVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The latest version number of the configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Quick Setup type.
" + } + }, + "com.amazonaws.ssmquicksetup#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The resource couldn't be found. Check the ID or name and try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.ssmquicksetup#ServiceSettings": { + "type": "structure", + "members": { + "ExplorerEnablingRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The IAM role used to enable Explorer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings configured for Quick Setup.
" + } + }, + "com.amazonaws.ssmquicksetup#Status": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "DEPLOYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "STOP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_FAILED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.ssmquicksetup#StatusDetails": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.ssmquicksetup#StatusSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#StatusSummary" + } + }, + "com.amazonaws.ssmquicksetup#StatusSummary": { + "type": "structure", + "members": { + "StatusType": { + "target": "com.amazonaws.ssmquicksetup#StatusType", + "traits": { + "smithy.api#documentation": "The type of a status summary.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.ssmquicksetup#Status", + "traits": { + "smithy.api#documentation": "The current status.
" + } + }, + "StatusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
" + } + }, + "LastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The datetime stamp when the status was last updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "StatusDetails": { + "target": "com.amazonaws.ssmquicksetup#StatusDetails", + "traits": { + "smithy.api#documentation": "Details about the status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summarized description of the status.
" + } + }, + "com.amazonaws.ssmquicksetup#StatusType": { + "type": "enum", + "members": { + "DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deployment" + } + }, + "ASYNC_EXECUTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AsyncExecutions" + } + } + } + }, + "com.amazonaws.ssmquicksetup#TagEntry": { + "type": "structure", + "members": { + "Key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key for the tag.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]+$" + } + }, + "Value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value for the tag.
", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]+$" + } + } + }, + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssmquicksetup#TagKeys": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.ssmquicksetup#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#TagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns key-value pairs of metadata to Amazon Web Services resources.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource to tag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.ssmquicksetup#TagsMap", + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata to assign to the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#TagEntry" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssmquicksetup#TagsMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]+$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]+$" + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssmquicksetup#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.ssmquicksetup#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#UntagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from the specified resource.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource to remove tags from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.ssmquicksetup#TagKeys", + "traits": { + "smithy.api#documentation": "The keys of the tags to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateConfigurationDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#UpdateConfigurationDefinitionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a Quick Setup configuration definition.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/configurationDefinition/{ManagerArn}/{Id}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateConfigurationDefinitionInput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the configuration manager associated with the definition to\n update.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^arn:aws:ssm-quicksetup:([^:]+):(\\d{12}):configuration-manager/[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "smithy.api#required": {} + } + }, + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the configuration definition you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^[a-z0-9-]{1,20}$", + "smithy.api#required": {} + } + }, + "TypeVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the Quick Setup type to use.
", + "smithy.api#pattern": "^\\d{1,3}(\\.\\d{1,3})?$|^LATEST$" + } + }, + "Parameters": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", + "traits": { + "smithy.api#documentation": "The parameters for the configuration definition type.
" + } + }, + "LocalDeploymentExecutionRoleName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the IAM role used to deploy local\n configurations.
", + "smithy.api#pattern": "^[\\w+=,.@-]{1,64}$" + } + }, + "LocalDeploymentAdministrationRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role used to administrate local configuration\n deployments.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateConfigurationManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#UpdateConfigurationManagerInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a Quick Setup configuration manager.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/configurationManager/{ManagerArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateConfigurationManagerInput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the configuration manager.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^arn:aws:ssm-quicksetup:([^:]+):(\\d{12}):configuration-manager/[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "smithy.api#required": {} + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A name for the configuration manager.
", + "smithy.api#pattern": "^[ A-Za-z0-9._-]{0,120}$" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the configuration manager.
", + "smithy.api#pattern": "^.{0,512}$" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateServiceSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#UpdateServiceSettingsInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates settings configured for Quick Setup.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/serviceSettings" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateServiceSettingsInput": { + "type": "structure", + "members": { + "ExplorerEnablingRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The IAM role used to enable Explorer.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request is invalid. Verify the values provided for the request parameters are\n accurate.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/support.json b/codegen/sdk-codegen/aws-models/support.json index b0f5eb9a8eb..90099d61b5f 100644 --- a/codegen/sdk-codegen/aws-models/support.json +++ b/codegen/sdk-codegen/aws-models/support.json @@ -94,7 +94,7 @@ "name": "support" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "The Amazon Web Services Support API Reference is intended for programmers who need detailed\n information about the Amazon Web Services Support operations and data types. You can use the API to manage\n your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return\n results in JSON format.
\nYou must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.
\nIf you call the Amazon Web Services Support API from an account that doesn't have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.
You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of\n checks and their descriptions, get check results, specify checks to refresh, and get the\n refresh status of checks.
\nYou can manage your support cases with the following Amazon Web Services Support API operations:
\nThe CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations\n create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
\nThe DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support\n cases.
\nThe DescribeServices and DescribeSeverityLevels operations return Amazon Web Service names, service codes, service categories, and problem\n severity levels. You use these values when you call the CreateCase operation.
\nYou can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more\n information, see Trusted Advisor in the\n Amazon Web Services Support User Guide.
\nFor authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing\n Process.
\nFor more information about this service and the endpoints to use, see About the\n Amazon Web Services Support API in the Amazon Web Services Support User Guide.
", + "smithy.api#documentation": "The Amazon Web Services Support API Reference is intended for programmers who need detailed\n information about the Amazon Web Services Support operations and data types. You can use the API to manage\n your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return\n results in JSON format.
\nYou must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.
\nIf you call the Amazon Web Services Support API from an account that doesn't have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.
You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of\n checks and their descriptions, get check results, specify checks to refresh, and get the\n refresh status of checks.
\nYou can manage your support cases with the following Amazon Web Services Support API operations:
\nThe CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations\n create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
\nThe DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support\n cases.
\nThe DescribeServices and DescribeSeverityLevels operations return Amazon Web Service names, service codes, service categories, and problem\n severity levels. You use these values when you call the CreateCase operation.
\nYou can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more\n information, see Trusted Advisor in the\n Amazon Web Services Support User Guide.
\nFor authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing\n Process.
\nFor more information about this service and the endpoints to use, see About the\n Amazon Web Services Support API in the Amazon Web Services Support User Guide.
", "smithy.api#title": "AWS Support", "smithy.api#xmlNamespace": { "uri": "http://support.amazonaws.com/doc/2013-04-15/" @@ -1387,7 +1387,7 @@ } }, "traits": { - "smithy.api#documentation": "An attachment to a case communication. The attachment consists of the file name and\n the content of the file.
" + "smithy.api#documentation": "An attachment to a case communication. The attachment consists of the file name and\n the content of the file. Each attachment file size should not exceed 5 MB. File types that are supported include the following: pdf, jpeg,.doc, .log, .text
" } }, "com.amazonaws.support#AttachmentDetails": { @@ -1554,7 +1554,7 @@ "status": { "target": "com.amazonaws.support#Status", "traits": { - "smithy.api#documentation": "The status of the case.
\nValid values:
\n\n opened\n
\n pending-customer-action\n
\n reopened\n
\n resolved\n
\n unassigned\n
\n work-in-progress\n
The status of the case.
\nValid values:
\n\n all-open\n
\n customer-action-completed\n
\n opened\n
\n pending-customer-action\n
\n reopened\n
\n resolved\n
\n unassigned\n
\n work-in-progress\n
A JSON-formatted object that contains the metadata for a support case. It is contained\n in the response from a DescribeCases request. CaseDetails contains the following fields:
\n\n caseId - The support case ID requested\n or returned in the call. The case ID is an alphanumeric string formatted as\n shown in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47.
\n\n categoryCode - The category of problem\n for the support case. Corresponds to the CategoryCode values\n returned by a call to DescribeServices.
\n displayId - The identifier for the case\n on pages in the Amazon Web Services Support Center.
\n\n language - The language in which Amazon Web Services Support handles the case. Amazon Web Services Support\ncurrently supports Chinese (“zh”), English (\"en\"), Japanese (\"ja\") and Korean (“ko”). You must specify the ISO 639-1\ncode for the language parameter if you want support in that language.
\n nextToken - A resumption point for\n pagination.
\n\n recentCommunications - One or more Communication objects. Fields of these objects are\n attachments, body, caseId,\n submittedBy, and timeCreated.
\n serviceCode - The identifier for the\n Amazon Web Services service that corresponds to the service code defined in the call to DescribeServices.
\n\n severityCode - The severity code\n assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are:\n low, normal, high,\n urgent, and critical.
\n status - The status of the case in the\n Amazon Web Services Support Center. Valid values:
\n\n opened\n
\n pending-customer-action\n
\n reopened\n
\n resolved\n
\n unassigned\n
\n work-in-progress\n
\n subject - The subject line of the\n case.
\n\n submittedBy - The email address of the\n account that submitted the case.
\n\n timeCreated - The time the case was\n created, in ISO-8601 format.
\nA JSON-formatted object that contains the metadata for a support case. It is contained\n in the response from a DescribeCases request. CaseDetails contains the following fields:
\n\n caseId - The support case ID requested\n or returned in the call. The case ID is an alphanumeric string formatted as\n shown in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47.
\n\n categoryCode - The category of problem\n for the support case. Corresponds to the CategoryCode values\n returned by a call to DescribeServices.
\n displayId - The identifier for the case\n on pages in the Amazon Web Services Support Center.
\n\n language - The language in which Amazon Web Services Support handles the case. Amazon Web Services Support\ncurrently supports Chinese (“zh”), English (\"en\"), Japanese (\"ja\") and Korean (“ko”). You must specify the ISO 639-1\ncode for the language parameter if you want support in that language.
\n nextToken - A resumption point for\n pagination.
\n\n recentCommunications - One or more Communication objects. Fields of these objects are\n attachments, body, caseId,\n submittedBy, and timeCreated.
\n serviceCode - The identifier for the\n Amazon Web Services service that corresponds to the service code defined in the call to DescribeServices.
\n\n severityCode - The severity code\n assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are:\n low, normal, high,\n urgent, and critical.
\n status - The status of the case in the\n Amazon Web Services Support Center. Valid values:
\n\n all-open\n
\n customer-action-completed\n
\n opened\n
\n pending-customer-action\n
\n reopened\n
\n resolved\n
\n unassigned\n
\n work-in-progress\n
\n subject - The subject line of the\n case.
\n\n submittedBy - The email address of the\n account that submitted the case.
\n\n timeCreated - The time the case was\n created, in ISO-8601 format.
\n