The number of vCPUs of the instance type included in your fleet.
" + } + }, + "memory": { + "target": "com.amazonaws.codebuild#WrapperLong", + "traits": { + "smithy.api#documentation": "The amount of memory of the instance type included in your fleet.
" + } + }, + "disk": { + "target": "com.amazonaws.codebuild#WrapperLong", + "traits": { + "smithy.api#documentation": "The amount of disk space of the instance type included in your fleet.
" + } + }, + "machineType": { + "target": "com.amazonaws.codebuild#MachineType", + "traits": { + "smithy.api#documentation": "The machine type of the instance type included in your fleet.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains compute attributes. These attributes only need be specified when your project's or fleet's computeType is set to ATTRIBUTE_BASED_COMPUTE.
Information about the compute resources the compute fleet uses. Available values\n include:
\n\n BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment\n compute types in the CodeBuild User Guide.\n
", + "smithy.api#documentation": "Information about the compute resources the compute fleet uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
", "smithy.api#required": {} } }, + "computeConfiguration": { + "target": "com.amazonaws.codebuild#ComputeConfiguration", + "traits": { + "smithy.api#documentation": "The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
Information about the compute resources the compute fleet uses. Available values\n include:
\n\n BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment\n compute types in the CodeBuild User Guide.\n
" + "smithy.api#documentation": "Information about the compute resources the compute fleet uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
" + } + }, + "computeConfiguration": { + "target": "com.amazonaws.codebuild#ComputeConfiguration", + "traits": { + "smithy.api#documentation": "The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
Information about build logs in CloudWatch Logs.
" } }, + "com.amazonaws.codebuild#MachineType": { + "type": "enum", + "members": { + "GENERAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERAL" + } + }, + "NVME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NVME" + } + } + } + }, "com.amazonaws.codebuild#NetworkInterface": { "type": "structure", "members": { @@ -6442,10 +6509,16 @@ "computeType": { "target": "com.amazonaws.codebuild#ComputeType", "traits": { - "smithy.api#documentation": "Information about the compute resources the build project uses. Available values\n include:
\n\n BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB\n memory and 8 vCPUs on ARM-based processors for builds.
If you're using compute fleets during project creation, computeType will be ignored.
For more information, see Build Environment\n Compute Types in the CodeBuild User Guide.\n
", + "smithy.api#documentation": "Information about the compute resources the build project uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
", "smithy.api#required": {} } }, + "computeConfiguration": { + "target": "com.amazonaws.codebuild#ComputeConfiguration", + "traits": { + "smithy.api#documentation": "The compute configuration of the build project. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
Information about the compute resources the compute fleet uses. Available values\n include:
\n\n BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment\n compute types in the CodeBuild User Guide.\n
" + "smithy.api#documentation": "Information about the compute resources the compute fleet uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
" + } + }, + "computeConfiguration": { + "target": "com.amazonaws.codebuild#ComputeConfiguration", + "traits": { + "smithy.api#documentation": "The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the detector that specifies the GuardDuty service whose findings you want to\n archive.
", + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings you want to\n archive.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The detector ID associated with the GuardDuty account for which you want to create a filter.
", + "smithy.api#documentation": "The detector ID associated with the GuardDuty account for which you want to create a filter.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
", + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector of the GuardDuty account for which you want to associate member\n accounts.
", + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account for which you want to associate member\n accounts.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the GuardDuty detector associated with the publishing destination.
", + "smithy.api#documentation": "The ID of the GuardDuty detector associated with the publishing destination.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the detector for which you need to create sample findings.
", + "smithy.api#documentation": "The ID of the detector for which you need to create sample findings.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector of the GuardDuty account for which you want to create a\n ThreatIntelSet.
The unique ID of the detector of the GuardDuty account for which you want to create a\n ThreatIntelSet.
To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that you want to delete.
", + "smithy.api#documentation": "The unique ID of the detector that you want to delete.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with the filter.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with the filter.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector associated with the IPSet.
", + "smithy.api#documentation": "The unique ID of the detector associated with the IPSet.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector of the GuardDuty account whose members you want to\n delete.
", + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account whose members you want to\n delete.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector associated with the publishing destination to delete.
", + "smithy.api#documentation": "The unique ID of the detector associated with the publishing destination to delete.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with the threatIntelSet.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with the threatIntelSet.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that the request is associated with.
", + "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The detector ID of the delegated administrator for which you need to retrieve the information.
", + "smithy.api#documentation": "The detector ID of the delegated administrator for which you need to retrieve the information.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector associated with the publishing destination to\n retrieve.
", + "smithy.api#documentation": "The unique ID of the detector associated with the publishing destination to\n retrieve.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the GuardDuty detector.
", + "smithy.api#documentation": "The unique ID of the GuardDuty detector.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that you want to get.
", + "smithy.api#documentation": "The unique ID of the detector that you want to get.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with this filter.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with this filter.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the detector that specifies the GuardDuty service whose findings you want to\n retrieve.
", + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings you want to\n retrieve.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the detector whose findings statistics you\n want to retrieve.
", + "smithy.api#documentation": "The ID of the detector whose findings statistics you\n want to retrieve.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with the IPSet.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with the IPSet.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with this scan.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with this scan.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The detector ID for the administrator account.
", + "smithy.api#documentation": "The detector ID for the administrator account.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector of the GuardDuty account whose members you want to\n retrieve.
", + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account whose members you want to\n retrieve.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with the threatIntelSet.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with the threatIntelSet.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the detector that specifies the GuardDuty service whose usage statistics you\n want to retrieve.
", + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose usage statistics you\n want to retrieve.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector of the GuardDuty account with which you want to invite members.
", + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account with which you want to invite members.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector whose coverage details you want to retrieve.
", + "smithy.api#documentation": "The unique ID of the detector whose coverage details you want to retrieve.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with the filter.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with the filter.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the detector that specifies the GuardDuty service whose findings you want to\n list.
", + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings you want to\n list.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with IPSet.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with IPSet.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with the member.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with the member.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The detector ID for which you want to retrieve the publishing destination.
", + "smithy.api#documentation": "The detector ID for which you want to retrieve the publishing destination.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with the threatIntelSet.
", + "smithy.api#documentation": "The unique ID of the detector that is associated with the threatIntelSet.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
Instance tag key-value pairs associated with the database instance ID.
", + "smithy.api#documentation": "Information about the tag key-value pairs.
", "smithy.api#jsonName": "tags" } } @@ -12294,6 +12294,63 @@ "smithy.api#documentation": "Contains information about the user and authentication details for a database instance\n involved in the finding.
" } }, + "com.amazonaws.guardduty#RdsLimitlessDbDetails": { + "type": "structure", + "members": { + "DbShardGroupIdentifier": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name associated with the Limitless DB shard group.
", + "smithy.api#jsonName": "dbShardGroupIdentifier" + } + }, + "DbShardGroupResourceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The resource identifier of the DB shard group within the Limitless Database.
", + "smithy.api#jsonName": "dbShardGroupResourceId" + } + }, + "DbShardGroupArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the DB shard group.
", + "smithy.api#jsonName": "dbShardGroupArn" + } + }, + "Engine": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The database engine of the database instance involved in the finding.
", + "smithy.api#jsonName": "engine" + } + }, + "EngineVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version of the database engine.
", + "smithy.api#jsonName": "engineVersion" + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the database cluster that is a part of the Limitless Database.
", + "smithy.api#jsonName": "dbClusterIdentifier" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "Information about the tag-key value pair.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the resource type RDSLimitlessDB that is involved in a GuardDuty\n finding.
Contains information about the RDS Limitless database that was involved in a GuardDuty finding.
", + "smithy.api#jsonName": "rdsLimitlessDbDetails" + } + }, "RdsDbUserDetails": { "target": "com.amazonaws.guardduty#RdsDbUserDetails", "traits": { @@ -12987,14 +13051,14 @@ "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
", + "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique detector ID of the administrator account that the request is associated with.\n If the account is an administrator, the AdminDetectorId will be the same as the one used for \n DetectorId.
The unique detector ID of the administrator account that the request is associated with.\n If the account is an administrator, the AdminDetectorId will be the same as the one used for \n DetectorId.
To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector of the GuardDuty administrator account associated with the\n member accounts to monitor.
", + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty administrator account associated with the\n member accounts to monitor.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector associated with the GuardDuty administrator account that is\n monitoring member accounts.
", + "smithy.api#documentation": "The unique ID of the detector associated with the GuardDuty administrator account that is\n monitoring member accounts.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The EC2 instance tag key.
", + "smithy.api#documentation": "Describes the key associated with the tag.
", "smithy.api#jsonName": "key" } }, "Value": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "The EC2 instance tag value.
", + "smithy.api#documentation": "Describes the value associated with the tag key.
", "smithy.api#jsonName": "value" } } }, "traits": { - "smithy.api#documentation": "Contains information about a tag associated with the EC2 instance.
" + "smithy.api#documentation": "Contains information about a tag key-value pair.
" } }, "com.amazonaws.guardduty#TagKey": { @@ -14364,7 +14428,7 @@ "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "The ID of the detector associated with the findings to unarchive.
", + "smithy.api#documentation": "The ID of the detector associated with the findings to unarchive.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector to update.
", + "smithy.api#documentation": "The unique ID of the detector to update.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that specifies the GuardDuty service where you want to\n update a filter.
", + "smithy.api#documentation": "The unique ID of the detector that specifies the GuardDuty service where you want to\n update a filter.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the detector that is associated with the findings for which you want to update \n the feedback.
", + "smithy.api#documentation": "The ID of the detector that is associated with the findings for which you want to update \n the feedback.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The detectorID that specifies the GuardDuty service whose IPSet you want to update.
", + "smithy.api#documentation": "The detectorID that specifies the GuardDuty service whose IPSet you want to update.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that specifies the GuardDuty service where you want to\n update scan settings.
", + "smithy.api#documentation": "The unique ID of the detector that specifies the GuardDuty service where you want to\n update scan settings.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The detector ID of the administrator account.
", + "smithy.api#documentation": "The detector ID of the administrator account.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the detector that configures the delegated administrator.
", + "smithy.api#documentation": "The ID of the detector that configures the delegated administrator.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The ID of the detector associated with the publishing destinations to update.
", + "smithy.api#documentation": "The ID of the detector associated with the publishing destinations to update.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to\n update.
", + "smithy.api#documentation": "The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to\n update.
\nTo find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
Creates a new LF-Tag expression with the provided name, description, catalog ID, and\n expression body. This call fails if a LF-Tag expression with the same name already exists in\n the caller’s account or if the underlying LF-Tags don't exist. To call this API operation,\n caller needs the following Lake Formation permissions:
\n\n CREATE_LF_TAG_EXPRESSION on the root catalog resource.
\n GRANT_WITH_LF_TAG_EXPRESSION on all underlying LF-Tag key:value pairs\n included in the expression.
A name for the expression.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.lakeformation#DescriptionString", + "traits": { + "smithy.api#documentation": "A description with information about the LF-Tag expression.
" + } + }, + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" + } + }, + "Expression": { + "target": "com.amazonaws.lakeformation#Expression", + "traits": { + "smithy.api#documentation": "A list of LF-Tag conditions (key-value pairs).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lakeformation#CreateLFTagExpressionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lakeformation#CreateLFTagRequest": { "type": "structure", "members": { @@ -2459,6 +2552,12 @@ "traits": { "smithy.api#enumValue": "LF_TAG_POLICY_TABLE" } + }, + "LF_NAMED_TAG_EXPRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LF_NAMED_TAG_EXPRESSION" + } } } }, @@ -2691,6 +2790,68 @@ } } }, + "com.amazonaws.lakeformation#DeleteLFTagExpression": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#DeleteLFTagExpressionRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#DeleteLFTagExpressionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the LF-Tag expression. The caller must be a data lake admin or have DROP permissions on the LF-Tag expression.\n Deleting a LF-Tag expression will also delete all LFTagPolicy permissions referencing the LF-Tag expression.
The name for the LF-Tag expression.
", + "smithy.api#required": {} + } + }, + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID in which the LF-Tag expression is saved.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lakeformation#DeleteLFTagExpressionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lakeformation#DeleteLFTagRequest": { "type": "structure", "members": { @@ -3824,6 +3985,93 @@ } } }, + "com.amazonaws.lakeformation#GetLFTagExpression": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#GetLFTagExpressionRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#GetLFTagExpressionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details about the LF-Tag expression. The caller must be a data lake admin or must have DESCRIBE permission on the LF-Tag expression resource.\n
The name for the LF-Tag expression
", + "smithy.api#required": {} + } + }, + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lakeformation#GetLFTagExpressionResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The name for the LF-Tag expression.
" + } + }, + "Description": { + "target": "com.amazonaws.lakeformation#DescriptionString", + "traits": { + "smithy.api#documentation": "The description with information about the LF-Tag expression.
" + } + }, + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID in which the LF-Tag expression is saved.
" + } + }, + "Expression": { + "target": "com.amazonaws.lakeformation#Expression", + "traits": { + "smithy.api#documentation": "The body of the LF-Tag expression. It is composed of one or more LF-Tag key-value pairs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lakeformation#GetLFTagRequest": { "type": "structure", "members": { @@ -4395,7 +4643,7 @@ } ], "traits": { - "smithy.api#documentation": "Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
", + "smithy.api#documentation": "Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
\nTo call this API, the role that the service assumes must have lakeformation:GetDataAccess permission on the resource.
The name for saved the LF-Tag expression.
" + } + }, + "Description": { + "target": "com.amazonaws.lakeformation#DescriptionString", + "traits": { + "smithy.api#documentation": "A structure that contains information about the LF-Tag expression.
" + } + }, + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID.
" + } + }, + "Expression": { + "target": "com.amazonaws.lakeformation#Expression", + "traits": { + "smithy.api#documentation": "A logical expression composed of one or more LF-Tags.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure consists LF-Tag expression name and catalog ID.
" + } + }, + "com.amazonaws.lakeformation#LFTagExpressionResource": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID.
" + } + }, + "Name": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The name of the LF-Tag expression to grant permissions on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing a LF-Tag expression (keys and values).
" + } + }, + "com.amazonaws.lakeformation#LFTagExpressionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#LFTagExpression" + } + }, "com.amazonaws.lakeformation#LFTagKey": { "type": "string", "traits": { @@ -5005,13 +5312,20 @@ "Expression": { "target": "com.amazonaws.lakeformation#Expression", "traits": { - "smithy.api#documentation": "A list of LF-tag conditions that apply to the resource's LF-tag policy.
", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#documentation": "A list of LF-tag conditions or a saved expression that apply to the resource's LF-tag policy.
" + } + }, + "ExpressionName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags\n match the expression body of the saved expression under the provided\n ExpressionName.
A structure containing a list of LF-tag conditions that apply to a resource's LF-tag policy.
" + "smithy.api#documentation": "A structure containing a list of LF-tag conditions or saved LF-Tag expressions that apply to a resource's LF-tag policy.
" } }, "com.amazonaws.lakeformation#LFTagValue": { @@ -5154,6 +5468,92 @@ "smithy.api#output": {} } }, + "com.amazonaws.lakeformation#ListLFTagExpressions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#ListLFTagExpressionsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#ListLFTagExpressionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListLFTagExpressions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LFTagExpressions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lakeformation#ListLFTagExpressionsRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lakeformation#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is not the first call to retrieve this list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lakeformation#ListLFTagExpressionsResponse": { + "type": "structure", + "members": { + "LFTagExpressions": { + "target": "com.amazonaws.lakeformation#LFTagExpressionsList", + "traits": { + "smithy.api#documentation": "Logical expressions composed of one more LF-Tag key-value pairs.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is not the first call to retrieve this list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lakeformation#ListLFTags": { "type": "operation", "input": { @@ -5959,6 +6359,12 @@ "traits": { "smithy.api#enumValue": "GRANT_WITH_LF_TAG_EXPRESSION" } + }, + "CREATE_LF_TAG_EXPRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_LF_TAG_EXPRESSION" + } } } }, @@ -6373,7 +6779,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers the resource as managed by the Data Catalog.
\nTo add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
\nThe following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
\n\n ResourceArn = arn:aws:s3:::my-bucket\nUseServiceLinkedRole = true\n
If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:
\n arn:aws:iam::12345:role/my-data-access-role\n
Registers the resource as managed by the Data Catalog.
\nTo add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
\nThe following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
\n\n ResourceArn = arn:aws:s3:::my-bucket/\nUseServiceLinkedRole = true\n
If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:
\n arn:aws:iam::12345:role/my-data-access-role\n
A list of LF-tag conditions that define a resource's LF-tag policy.
" + "smithy.api#documentation": "A list of LF-tag conditions or saved LF-Tag expressions that define a resource's LF-tag policy.
" + } + }, + "LFTagExpression": { + "target": "com.amazonaws.lakeformation#LFTagExpressionResource", + "traits": { + "smithy.api#documentation": "LF-Tag expression resource. A logical expression composed of one or more LF-Tag key:value pairs.
" } } }, @@ -7765,6 +8177,84 @@ } } }, + "com.amazonaws.lakeformation#UpdateLFTagExpression": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#UpdateLFTagExpressionRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#UpdateLFTagExpressionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#ResourceNumberLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the name of the LF-Tag expression to the new description and expression body provided.\n Updating a LF-Tag expression immediately changes the permission boundaries of all existing LFTagPolicy permission grants that reference the given LF-Tag expression.
The name for the LF-Tag expression.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.lakeformation#DescriptionString", + "traits": { + "smithy.api#documentation": "The description with information about the saved LF-Tag expression.
" + } + }, + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID.
" + } + }, + "Expression": { + "target": "com.amazonaws.lakeformation#Expression", + "traits": { + "smithy.api#documentation": "The LF-Tag expression body composed of one more LF-Tag key-value pairs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lakeformation#UpdateLFTagExpressionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lakeformation#UpdateLFTagRequest": { "type": "structure", "members": { @@ -8104,7 +8594,7 @@ "StorageOptimizerConfig": { "target": "com.amazonaws.lakeformation#StorageOptimizerConfigMap", "traits": { - "smithy.api#documentation": "Name of the table for which to enable the storage optimizer.
", + "smithy.api#documentation": "Name of the configuration for the storage optimizer.
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/qapps.json b/codegen/sdk-codegen/aws-models/qapps.json index 6d5be6904c1..b5af428cf64 100644 --- a/codegen/sdk-codegen/aws-models/qapps.json +++ b/codegen/sdk-codegen/aws-models/qapps.json @@ -180,7 +180,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates a rating or review for a library item with the user submitting \n the request. This increments the rating count for the specified library item.
", + "smithy.api#documentation": "Associates a rating or review for a library item with the user submitting\n the request. This increments the rating count for the specified library item.
", "smithy.api#examples": [ { "title": "Increase the rating counter by 1 for the related app for this user", @@ -364,6 +364,287 @@ "target": "com.amazonaws.qapps#AttributeFilter" } }, + "com.amazonaws.qapps#BatchCreateCategory": { + "type": "operation", + "input": { + "target": "com.amazonaws.qapps#BatchCreateCategoryInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.qapps#AccessDeniedException" + }, + { + "target": "com.amazonaws.qapps#ConflictException" + }, + { + "target": "com.amazonaws.qapps#InternalServerException" + }, + { + "target": "com.amazonaws.qapps#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qapps#ThrottlingException" + }, + { + "target": "com.amazonaws.qapps#UnauthorizedException" + }, + { + "target": "com.amazonaws.qapps#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
", + "smithy.api#examples": [ + { + "title": "Creates the categories for the library", + "input": { + "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f", + "categories": [ + { + "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d", + "title": "HR" + }, + { + "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f", + "title": "Marketing" + } + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/catalog.createCategories" + } + } + }, + "com.amazonaws.qapps#BatchCreateCategoryInput": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.qapps#InstanceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon Q Business application environment instance.
", + "smithy.api#httpHeader": "instance-id", + "smithy.api#required": {} + } + }, + "categories": { + "target": "com.amazonaws.qapps#BatchCreateCategoryInputCategoryList", + "traits": { + "smithy.api#documentation": "The list of category objects to be created
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qapps#BatchCreateCategoryInputCategory": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.qapps#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier to be associated with a category. If you don't include a value, the category is automatically assigned a unique identifier.
" + } + }, + "title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the category.
", + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]+( [a-zA-Z0-9_]+)*$", + "smithy.api#required": {} + } + }, + "color": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The color to be associated with a category. The color must be a hexadecimal value of either 3 or 6 digits.
", + "smithy.api#length": { + "min": 4, + "max": 7 + }, + "smithy.api#pattern": "^#([A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$" + } + } + }, + "traits": { + "smithy.api#documentation": "The category object to be created.
" + } + }, + "com.amazonaws.qapps#BatchCreateCategoryInputCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qapps#BatchCreateCategoryInputCategory" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.qapps#BatchDeleteCategory": { + "type": "operation", + "input": { + "target": "com.amazonaws.qapps#BatchDeleteCategoryInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.qapps#AccessDeniedException" + }, + { + "target": "com.amazonaws.qapps#ConflictException" + }, + { + "target": "com.amazonaws.qapps#InternalServerException" + }, + { + "target": "com.amazonaws.qapps#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qapps#ThrottlingException" + }, + { + "target": "com.amazonaws.qapps#UnauthorizedException" + }, + { + "target": "com.amazonaws.qapps#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
", + "smithy.api#examples": [ + { + "title": "Deletes the categories in the library", + "input": { + "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f", + "categories": [ + "9c871ed4-1c41-4065-aefe-321cd4b61cf8" + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/catalog.deleteCategories" + } + } + }, + "com.amazonaws.qapps#BatchDeleteCategoryInput": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.qapps#InstanceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon Q Business application environment instance.
", + "smithy.api#httpHeader": "instance-id", + "smithy.api#required": {} + } + }, + "categories": { + "target": "com.amazonaws.qapps#DeleteCategoryInputList", + "traits": { + "smithy.api#documentation": "The list of IDs of the categories to be deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qapps#BatchUpdateCategory": { + "type": "operation", + "input": { + "target": "com.amazonaws.qapps#BatchUpdateCategoryInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.qapps#AccessDeniedException" + }, + { + "target": "com.amazonaws.qapps#ConflictException" + }, + { + "target": "com.amazonaws.qapps#InternalServerException" + }, + { + "target": "com.amazonaws.qapps#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qapps#ThrottlingException" + }, + { + "target": "com.amazonaws.qapps#UnauthorizedException" + }, + { + "target": "com.amazonaws.qapps#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
", + "smithy.api#examples": [ + { + "title": "Updates the categories in the library", + "input": { + "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f", + "categories": [ + { + "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d", + "title": "HR Management" + }, + { + "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f", + "title": "Sales" + } + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/catalog.updateCategories" + } + } + }, + "com.amazonaws.qapps#BatchUpdateCategoryInput": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.qapps#InstanceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon Q Business application environment instance.
", + "smithy.api#httpHeader": "instance-id", + "smithy.api#required": {} + } + }, + "categories": { + "target": "com.amazonaws.qapps#CategoryListInput", + "traits": { + "smithy.api#documentation": "The list of categories to be updated with their new values.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.qapps#Card": { "type": "union", "members": { @@ -563,6 +844,17 @@ } } }, + "com.amazonaws.qapps#CategoriesList": { + "type": "list", + "member": { + "target": "com.amazonaws.qapps#Category" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, "com.amazonaws.qapps#Category": { "type": "structure", "members": { @@ -579,6 +871,18 @@ "smithy.api#documentation": "The title or name of the category.
", "smithy.api#required": {} } + }, + "color": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The color of the category
" + } + }, + "appCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of published Amazon Q Apps associated with a category
" + } } }, "traits": { @@ -596,6 +900,44 @@ } } }, + "com.amazonaws.qapps#CategoryInput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.qapps#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the category.
", + "smithy.api#required": {} + } + }, + "title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the category.
", + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]+( [a-zA-Z0-9_]+)*$", + "smithy.api#required": {} + } + }, + "color": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The color of the category, represented as a hexadecimal value of either 3 or 6 digits.
", + "smithy.api#length": { + "min": 4, + "max": 7 + }, + "smithy.api#pattern": "^#([A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$" + } + } + }, + "traits": { + "smithy.api#documentation": "A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.
" + } + }, "com.amazonaws.qapps#CategoryList": { "type": "list", "member": { @@ -607,6 +949,17 @@ } } }, + "com.amazonaws.qapps#CategoryListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.qapps#CategoryInput" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, "com.amazonaws.qapps#ConflictException": { "type": "structure", "members": { @@ -632,7 +985,7 @@ } }, "traits": { - "smithy.api#documentation": "The requested operation could not be completed due to a \n conflict with the current state of the resource.
", + "smithy.api#documentation": "The requested operation could not be completed due to a\n conflict with the current state of the resource.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -662,7 +1015,7 @@ } }, "traits": { - "smithy.api#documentation": "The requested operation could not be completed because \n the content exceeds the maximum allowed size.
", + "smithy.api#documentation": "The requested operation could not be completed because\n the content exceeds the maximum allowed size.
", "smithy.api#error": "client", "smithy.api#httpError": 413 } @@ -724,7 +1077,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new library item for an Amazon Q App, allowing it to be discovered and \n used by other allowed users.
", + "smithy.api#documentation": "Creates a new library item for an Amazon Q App, allowing it to be discovered and\n used by other allowed users.
", "smithy.api#examples": [ { "title": "Create a Library Item", @@ -1077,6 +1430,17 @@ } } }, + "com.amazonaws.qapps#DeleteCategoryInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.qapps#UUID" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, "com.amazonaws.qapps#DeleteLibraryItem": { "type": "operation", "input": { @@ -1109,7 +1473,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a library item for an Amazon Q App, removing it from the library \n so it can no longer be discovered or used by other users.
", + "smithy.api#documentation": "Deletes a library item for an Amazon Q App, removing it from the library\n so it can no longer be discovered or used by other users.
", "smithy.api#examples": [ { "title": "Delete a library item", @@ -1594,7 +1958,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a file upload card. It can optionally \n receive a filename and fileId to set a \n default file. If not received, the user must provide the file \n when the Q App runs.
Represents a file upload card. It can optionally\n receive a filename and fileId to set a\n default file. If not received, the user must provide the file\n when the Q App runs.
Retrieves details about a library item for an Amazon Q App, including its metadata, \n categories, ratings, and usage statistics.
", + "smithy.api#documentation": "Retrieves details about a library item for an Amazon Q App, including its metadata,\n categories, ratings, and usage statistics.
", "smithy.api#examples": [ { "title": "Retrieve a library item", @@ -2053,11 +2417,11 @@ "cardStatus": { "6fb5b404-3b7b-48a4-8a8b-56406922a606": { "currentState": "COMPLETED", - "currentValue": "What is the circumference of Earth?" + "currentValue": "" }, "1e6caeac-b481-45ff-a082-8b9a4a0b72e8": { "currentState": "COMPLETED", - "currentValue": "Earth's circumference is 24,901 miles" + "currentValue": "Based on the responses, the most popular color is red, with 1 vote from the user \"user1\"." } } } @@ -2165,7 +2529,7 @@ } ], "traits": { - "smithy.api#documentation": "Uploads a file that can then be used either as a default in a \n FileUploadCard from Q App definition or as a file that \n is used inside a single Q App run. The purpose of the document is \n determined by a scope parameter that indicates whether it is at the \n app definition level or at the app session level.
Uploads a file that can then be used either as a default in a\n FileUploadCard from Q App definition or as a file that\n is used inside a single Q App run. The purpose of the document is\n determined by a scope parameter that indicates whether it is at the\n app definition level or at the app session level.
A library item is a snapshot of an Amazon Q App \n that can be published so the users in their Amazon Q Apps library \n can discover it, clone it, and run it.
" + "smithy.api#documentation": "A library item is a snapshot of an Amazon Q App\n that can be published so the users in their Amazon Q Apps library\n can discover it, clone it, and run it.
" } }, "com.amazonaws.qapps#LibraryItemStatus": { @@ -2426,6 +2790,97 @@ } } }, + "com.amazonaws.qapps#ListCategories": { + "type": "operation", + "input": { + "target": "com.amazonaws.qapps#ListCategoriesInput" + }, + "output": { + "target": "com.amazonaws.qapps#ListCategoriesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.qapps#AccessDeniedException" + }, + { + "target": "com.amazonaws.qapps#InternalServerException" + }, + { + "target": "com.amazonaws.qapps#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qapps#ThrottlingException" + }, + { + "target": "com.amazonaws.qapps#UnauthorizedException" + }, + { + "target": "com.amazonaws.qapps#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.
", + "smithy.api#examples": [ + { + "title": "List categories available for the library items in this instance", + "input": { + "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f" + }, + "output": { + "categories": [ + { + "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d", + "title": "HR", + "color": "#FF6600", + "appCount": 10 + }, + { + "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f", + "title": "Marketing", + "color": "#FFFF00", + "appCount": 11 + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/catalog.listCategories" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qapps#ListCategoriesInput": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.qapps#InstanceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon Q Business application environment instance.
", + "smithy.api#httpHeader": "instance-id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qapps#ListCategoriesOutput": { + "type": "structure", + "members": { + "categories": { + "target": "com.amazonaws.qapps#CategoriesList", + "traits": { + "smithy.api#documentation": "The categories of a Amazon Q Business application environment instance.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qapps#ListLibraryItems": { "type": "operation", "input": { @@ -2630,7 +3085,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon Q Apps owned by or associated with the user either because \n they created it or because they used it from the library in the past. The user \n identity is extracted from the credentials used to invoke this operation..
", + "smithy.api#documentation": "Lists the Amazon Q Apps owned by or associated with the user either because\n they created it or because they used it from the library in the past. The user\n identity is extracted from the credentials used to invoke this operation..
", "smithy.api#examples": [ { "title": "List at most 3 Amazon Q Apps in an Q Business application", @@ -2968,7 +3423,7 @@ } }, "traits": { - "smithy.api#documentation": "The definition of an Amazon Q App generated based on input such as a conversation \n or problem statement.
" + "smithy.api#documentation": "The definition of an Amazon Q App generated based on input such as a conversation\n or problem statement.
" } }, "com.amazonaws.qapps#PredictQApp": { @@ -2997,7 +3452,7 @@ } ], "traits": { - "smithy.api#documentation": "Generates an Amazon Q App definition based on either a conversation or \n a problem statement provided as input.The resulting app definition\n can be used to call CreateQApp. This API doesn't create \n Amazon Q Apps directly.
Generates an Amazon Q App definition based on either a conversation or\n a problem statement provided as input.The resulting app definition\n can be used to call CreateQApp. This API doesn't create\n Amazon Q Apps directly.
The Amazon Q Apps feature capability within Amazon Q Business allows web experience \n users to create lightweight, purpose-built AI apps to fulfill specific tasks from \n within their web experience. For example, users can create a Q App that exclusively \n generates marketing-related content to improve your marketing team's productivity or a \n Q App for writing customer emails and creating promotional content using a certain \n style of voice, tone, and branding. For more information on the capabilities, see \n Amazon Q Apps capabilities in the Amazon Q Business User Guide. \n
\nFor an overview of the Amazon Q App APIs, see Overview of \n Amazon Q Apps API operations.
\nFor information about the IAM access control permissions you need to\n use the Amazon Q Apps API, see \n IAM role for the Amazon Q Business web experience including Amazon Q Apps in the\n Amazon Q Business User Guide.
", + "smithy.api#documentation": "The Amazon Q Apps feature capability within Amazon Q Business allows web experience\n users to create lightweight, purpose-built AI apps to fulfill specific tasks from\n within their web experience. For example, users can create a Q App that exclusively\n generates marketing-related content to improve your marketing team's productivity or a\n Q App for writing customer emails and creating promotional content using a certain\n style of voice, tone, and branding. For more information on the capabilities, see\n Amazon Q Apps capabilities in the Amazon Q Business User Guide.\n
\nFor an overview of the Amazon Q App APIs, see Overview of\n Amazon Q Apps API operations.
\nFor information about the IAM access control permissions you need to\n use the Amazon Q Apps API, see \n IAM role for the Amazon Q Business web experience including Amazon Q Apps in the\n Amazon Q Business User Guide.
", "smithy.api#title": "QApps", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -4001,7 +4468,7 @@ } }, "traits": { - "smithy.api#documentation": "A card in a Amazon Q App that generates a response \n based on the Amazon Q Business service.
" + "smithy.api#documentation": "A card in a Amazon Q App that generates a response\n based on the Amazon Q Business service.
" } }, "com.amazonaws.qapps#QQueryCardInput": { @@ -4140,7 +4607,7 @@ } }, "traits": { - "smithy.api#documentation": "The requested operation could not be completed because \n it would exceed the service's quota or limit.
", + "smithy.api#documentation": "The requested operation could not be completed because\n it would exceed the service's quota or limit.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -4177,7 +4644,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a new session for an Amazon Q App, allowing inputs to be provided \n and the app to be run.
\nEach Q App session will be condensed into a single conversation \n in the web experience.
\nStarts a new session for an Amazon Q App, allowing inputs to be provided\n and the app to be run.
\nEach Q App session will be condensed into a single conversation\n in the web experience.
\nStops an active session for an Amazon Q App.This deletes all data \n related to the session and makes it invalid for future uses. The \n results of the session will be persisted as part of the conversation.
", + "smithy.api#documentation": "Stops an active session for an Amazon Q App.This deletes all data\n related to the session and makes it invalid for future uses. The\n results of the session will be persisted as part of the conversation.
", "smithy.api#http": { "method": "POST", "uri": "/runtime.deleteMiniAppRun" @@ -4582,7 +5049,7 @@ } }, "traits": { - "smithy.api#documentation": "The requested operation could not be completed because too many \n requests were sent at once. Wait a bit and try again later.
", + "smithy.api#documentation": "The requested operation could not be completed because too many\n requests were sent at once. Wait a bit and try again later.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { @@ -4605,7 +5072,7 @@ "com.amazonaws.qapps#UUID": { "type": "string", "traits": { - "smithy.api#pattern": "^[\\da-f]{8}-[\\da-f]{4}-4[\\da-f]{3}-[89ABab][\\da-f]{3}-[\\da-f]{12}$" + "smithy.api#pattern": "^[\\da-f]{8}-[\\da-f]{4}-[45][\\da-f]{3}-[89ABab][\\da-f]{3}-[\\da-f]{12}$" } }, "com.amazonaws.qapps#UnauthorizedException": { @@ -5244,7 +5711,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the session for a given Q App sessionId. This is only \n valid when at least one card of the session is in the WAITING state. \n Data for each WAITING card can be provided as input. If inputs \n are not provided, the call will be accepted but session will not move forward. \n Inputs for cards that are not in the WAITING status will be ignored.
Updates the session for a given Q App sessionId. This is only\n valid when at least one card of the session is in the WAITING state.\n Data for each WAITING card can be provided as input. If inputs\n are not provided, the call will be accepted but session will not move forward.\n Inputs for cards that are not in the WAITING status will be ignored.
The virtual private cloud (VPC) configuration for this access point, if one exists.
\nThis element is empty if this access point is an Amazon S3 on Outposts access point that is used by other\n Amazon Web Servicesservices.
\nThe virtual private cloud (VPC) configuration for this access point, if one exists.
\nThis element is empty if this access point is an Amazon S3 on Outposts access point that is used by other\n Amazon Web Services services.
\nContains the virtual private cloud (VPC) configuration for the specified access point.
\nThis element is empty if this access point is an Amazon S3 on Outposts access point that is used by other\n Amazon Web Servicesservices.
\nContains the virtual private cloud (VPC) configuration for the specified access point.
\nThis element is empty if this access point is an Amazon S3 on Outposts access point that is used by other\n Amazon Web Services services.
\nA list of S3 Storage Lens configurations.
", - "smithy.api#xmlFlattened": {} + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StorageLensConfiguration" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#output": {}, + "smithy.api#xmlName": "ListStorageLensConfigurationResult" } }, "com.amazonaws.s3control#ListStorageLensGroupEntry": { @@ -14542,7 +14544,8 @@ "target": "com.amazonaws.s3control#StorageLensGroupList", "traits": { "smithy.api#documentation": "\nThe list of Storage Lens groups that exist in the specified home Region.\n
", - "smithy.api#xmlFlattened": {} + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StorageLensGroup" } } }, @@ -15732,7 +15735,7 @@ "target": "com.amazonaws.s3control#Setting", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this\n account. Setting this element to TRUE restricts access to buckets with public\n policies to only Amazon Web Servicesservice principals and authorized users within this\n account.
Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.
\nThis property is not supported for Amazon S3 on Outposts.
", + "smithy.api#documentation": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this\n account. Setting this element to TRUE restricts access to buckets with public\n policies to only Amazon Web Services service principals and authorized users within this\n account.
Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.
\nThis property is not supported for Amazon S3 on Outposts.
", "smithy.api#xmlName": "RestrictPublicBuckets" } } diff --git a/codegen/sdk-codegen/aws-models/verifiedpermissions.json b/codegen/sdk-codegen/aws-models/verifiedpermissions.json index 01f3eb95e57..b232e0bd31d 100644 --- a/codegen/sdk-codegen/aws-models/verifiedpermissions.json +++ b/codegen/sdk-codegen/aws-models/verifiedpermissions.json @@ -105,6 +105,18 @@ "traits": { "smithy.api#documentation": "An attribute value of Record\n type.
\nExample: {\"record\": { \"keyName\": {} } }\n
An attribute value of ipaddr type.
\nExample: {\"ip\": \"192.168.1.100\"}\n
An attribute value of decimal type.
\nExample: {\"decimal\": \"1.1\"}\n
Retrieves information about a group (batch) of policies.
\nThe BatchGetPolicy operation doesn't have its own IAM\n permission. To authorize this operation for Amazon Web Services principals, include the permission\n verifiedpermissions:GetPolicy in their IAM policies.
The error code that was returned.
", + "smithy.api#required": {} + } + }, + "policyStoreId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the policy store associated with the failed request.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the policy associated with the failed request.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A detailed error message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the information about an error resulting from a BatchGetPolicy API call.
An array of up to 100 policies you want information about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#BatchGetPolicyInputItem": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The identifier of the policy store where the policy you want information about is stored.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "The identifier of the policy you want information about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a policy that you include in a BatchGetPolicy API request.
Information about the policies listed in the request that were successfully returned. These results are returned in the order they were requested.
", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.verifiedpermissions#BatchGetPolicyErrorList", + "traits": { + "smithy.api#documentation": "Information about the policies from the request that resulted in an error. These results are returned in the order they were requested.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#BatchGetPolicyOutputItem": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The identifier of the policy store where the policy you want information about is stored.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "The identifier of the policy you want information about.
", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "The type of the policy. This is one of the following values:
\n\n STATIC\n
\n TEMPLATE_LINKED\n
The policy definition of an item in the list of policies returned.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a policy returned from a BatchGetPolicy API request.
A series of Allow or Deny decisions for each request, and\n the policies that produced them.
A series of Allow or Deny decisions for each request, and\n the policies that produced them. These results are returned in the order they were requested.
A series of Allow or Deny decisions for each request, and\n the policies that produced them.
A series of Allow or Deny decisions for each request, and\n the policies that produced them. These results are returned in the order they were requested.
The identifier of the PolicyStore where the policy you want information about is\n stored.
", + "smithy.api#documentation": "The identifier of the policy store where the policy you want information about is\n stored.
", "smithy.api#required": {} } }, @@ -4398,6 +4708,11 @@ "target": "com.amazonaws.verifiedpermissions#PutSchema" } ], + "collectionOperations": [ + { + "target": "com.amazonaws.verifiedpermissions#BatchGetPolicy" + } + ], "resources": [ { "target": "com.amazonaws.verifiedpermissions#IdentitySource" @@ -4850,8 +5165,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 100000 + "min": 1 }, "smithy.api#sensitive": {} }